Skip to content

Commit 20e4e9a

Browse files
jnavilagitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 7e7f47a commit 20e4e9a

File tree

1 file changed

+19
-21
lines changed

1 file changed

+19
-21
lines changed

Documentation/git-var.adoc

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -32,58 +32,56 @@ EXAMPLES
3232

3333
VARIABLES
3434
---------
35-
GIT_AUTHOR_IDENT::
35+
`GIT_AUTHOR_IDENT`::
3636
The author of a piece of code.
3737
38-
GIT_COMMITTER_IDENT::
38+
`GIT_COMMITTER_IDENT`::
3939
The person who put a piece of code into Git.
4040
41-
GIT_EDITOR::
41+
`GIT_EDITOR`::
4242
Text editor for use by Git commands. The value is meant to be
4343
interpreted by the shell when it is used. Examples: `~/bin/vi`,
4444
`$SOME_ENVIRONMENT_VARIABLE`, `"C:\Program Files\Vim\gvim.exe"
45-
--nofork`. The order of preference is the `$GIT_EDITOR`
46-
environment variable, then `core.editor` configuration, then
47-
`$VISUAL`, then `$EDITOR`, and then the default chosen at compile
45+
--nofork`. The order of preference is `$GIT_EDITOR`, then
46+
`core.editor` configuration value, then `$VISUAL`, then
47+
`$EDITOR`, and then the default chosen at compile
4848
time, which is usually 'vi'.
4949
ifdef::git-default-editor[]
5050
The build you are using chose '{git-default-editor}' as the default.
5151
endif::git-default-editor[]
5252
53-
GIT_SEQUENCE_EDITOR::
53+
`GIT_SEQUENCE_EDITOR`::
5454
Text editor used to edit the 'todo' file while running `git rebase
5555
-i`. Like `GIT_EDITOR`, the value is meant to be interpreted by
56-
the shell when it is used. The order of preference is the
57-
`$GIT_SEQUENCE_EDITOR` environment variable, then
58-
`sequence.editor` configuration, and then the value of `git var
59-
GIT_EDITOR`.
56+
the shell when it is used. The order of preference is
57+
`$GIT_SEQUENCE_EDITOR`, then `sequence.editor` configuration value,
58+
and then the value of `git var GIT_EDITOR`.
6059
61-
GIT_PAGER::
60+
`GIT_PAGER`::
6261
Text viewer for use by Git commands (e.g., 'less'). The value
6362
is meant to be interpreted by the shell. The order of preference
64-
is the `$GIT_PAGER` environment variable, then `core.pager`
65-
configuration, then `$PAGER`, and then the default chosen at
66-
compile time (usually 'less').
63+
is `$GIT_PAGER`, then the value of `core.pager` configuration, then
64+
`$PAGER`, and then the default chosen at compile time (usually `less`).
6765
ifdef::git-default-pager[]
6866
The build you are using chose '{git-default-pager}' as the default.
6967
endif::git-default-pager[]
7068
71-
GIT_DEFAULT_BRANCH::
69+
`GIT_DEFAULT_BRANCH`::
7270
The name of the first branch created in newly initialized repositories.
7371
74-
GIT_SHELL_PATH::
72+
`GIT_SHELL_PATH`::
7573
The path of the binary providing the POSIX shell for commands which use the shell.
7674
77-
GIT_ATTR_SYSTEM::
75+
`GIT_ATTR_SYSTEM`::
7876
The path to the system linkgit:gitattributes[5] file, if one is enabled.
7977
80-
GIT_ATTR_GLOBAL::
78+
`GIT_ATTR_GLOBAL`::
8179
The path to the global (per-user) linkgit:gitattributes[5] file.
8280
83-
GIT_CONFIG_SYSTEM::
81+
`GIT_CONFIG_SYSTEM`::
8482
The path to the system configuration file, if one is enabled.
8583
86-
GIT_CONFIG_GLOBAL::
84+
`GIT_CONFIG_GLOBAL`::
8785
The path to the global (per-user) configuration files, if any.
8886
8987
Most path values contain only one value. However, some can contain multiple

0 commit comments

Comments
 (0)