git-var doc: fix usage of $ENV_VAR vs ENV_VAR

When refering to environment variables in the documentation, use the
ENV_VARIABLE format instead of $ENV_VARIABLE. The latter is used in the
documentation to refer to the actual value of the variable, not the name
of the variable.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Jean-Noël Avila 2025-05-10 14:33:17 +02:00 committed by Junio C Hamano
parent 7e7f47a488
commit 20e4e9ad0b
1 changed files with 19 additions and 21 deletions

View File

@ -32,58 +32,56 @@ EXAMPLES


VARIABLES VARIABLES
--------- ---------
GIT_AUTHOR_IDENT:: `GIT_AUTHOR_IDENT`::
The author of a piece of code. The author of a piece of code.


GIT_COMMITTER_IDENT:: `GIT_COMMITTER_IDENT`::
The person who put a piece of code into Git. The person who put a piece of code into Git.


GIT_EDITOR:: `GIT_EDITOR`::
Text editor for use by Git commands. The value is meant to be Text editor for use by Git commands. The value is meant to be
interpreted by the shell when it is used. Examples: `~/bin/vi`, interpreted by the shell when it is used. Examples: `~/bin/vi`,
`$SOME_ENVIRONMENT_VARIABLE`, `"C:\Program Files\Vim\gvim.exe" `$SOME_ENVIRONMENT_VARIABLE`, `"C:\Program Files\Vim\gvim.exe"
--nofork`. The order of preference is the `$GIT_EDITOR` --nofork`. The order of preference is `$GIT_EDITOR`, then
environment variable, then `core.editor` configuration, then `core.editor` configuration value, then `$VISUAL`, then
`$VISUAL`, then `$EDITOR`, and then the default chosen at compile `$EDITOR`, and then the default chosen at compile
time, which is usually 'vi'. time, which is usually 'vi'.
ifdef::git-default-editor[] ifdef::git-default-editor[]
The build you are using chose '{git-default-editor}' as the default. The build you are using chose '{git-default-editor}' as the default.
endif::git-default-editor[] endif::git-default-editor[]


GIT_SEQUENCE_EDITOR:: `GIT_SEQUENCE_EDITOR`::
Text editor used to edit the 'todo' file while running `git rebase Text editor used to edit the 'todo' file while running `git rebase
-i`. Like `GIT_EDITOR`, the value is meant to be interpreted by -i`. Like `GIT_EDITOR`, the value is meant to be interpreted by
the shell when it is used. The order of preference is the the shell when it is used. The order of preference is
`$GIT_SEQUENCE_EDITOR` environment variable, then `$GIT_SEQUENCE_EDITOR`, then `sequence.editor` configuration value,
`sequence.editor` configuration, and then the value of `git var and then the value of `git var GIT_EDITOR`.
GIT_EDITOR`.


GIT_PAGER:: `GIT_PAGER`::
Text viewer for use by Git commands (e.g., 'less'). The value Text viewer for use by Git commands (e.g., 'less'). The value
is meant to be interpreted by the shell. The order of preference is meant to be interpreted by the shell. The order of preference
is the `$GIT_PAGER` environment variable, then `core.pager` is `$GIT_PAGER`, then the value of `core.pager` configuration, then
configuration, then `$PAGER`, and then the default chosen at `$PAGER`, and then the default chosen at compile time (usually `less`).
compile time (usually 'less').
ifdef::git-default-pager[] ifdef::git-default-pager[]
The build you are using chose '{git-default-pager}' as the default. The build you are using chose '{git-default-pager}' as the default.
endif::git-default-pager[] endif::git-default-pager[]


GIT_DEFAULT_BRANCH:: `GIT_DEFAULT_BRANCH`::
The name of the first branch created in newly initialized repositories. The name of the first branch created in newly initialized repositories.


GIT_SHELL_PATH:: `GIT_SHELL_PATH`::
The path of the binary providing the POSIX shell for commands which use the shell. The path of the binary providing the POSIX shell for commands which use the shell.


GIT_ATTR_SYSTEM:: `GIT_ATTR_SYSTEM`::
The path to the system linkgit:gitattributes[5] file, if one is enabled. The path to the system linkgit:gitattributes[5] file, if one is enabled.


GIT_ATTR_GLOBAL:: `GIT_ATTR_GLOBAL`::
The path to the global (per-user) linkgit:gitattributes[5] file. The path to the global (per-user) linkgit:gitattributes[5] file.


GIT_CONFIG_SYSTEM:: `GIT_CONFIG_SYSTEM`::
The path to the system configuration file, if one is enabled. The path to the system configuration file, if one is enabled.


GIT_CONFIG_GLOBAL:: `GIT_CONFIG_GLOBAL`::
The path to the global (per-user) configuration files, if any. The path to the global (per-user) configuration files, if any.


Most path values contain only one value. However, some can contain multiple Most path values contain only one value. However, some can contain multiple