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>
Jean-Noël Avila committed
May 10, 2025 at 14:33 UTC
20e4e9ad0b72be0a4ccf9300f51c383c03beec97
1 file changed
+19
-21
Documentation/git-var.adoc
+19
-21
@@ -32,58 +32,56 @@ EXAMPLES
32
33
VARIABLES
34
---------
35
-GIT_AUTHOR_IDENT::
35
+`GIT_AUTHOR_IDENT`::
36
The author of a piece of code.
37
38
-GIT_COMMITTER_IDENT::
38
+`GIT_COMMITTER_IDENT`::
39
The person who put a piece of code into Git.
40
41
-GIT_EDITOR::
41
+`GIT_EDITOR`::
42
Text editor for use by Git commands. The value is meant to be
43
interpreted by the shell when it is used. Examples: `~/bin/vi`,
44
`$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
48
time, which is usually 'vi'.
49
ifdef::git-default-editor[]
50
The build you are using chose '{git-default-editor}' as the default.
51
endif::git-default-editor[]
52
53
-GIT_SEQUENCE_EDITOR::
53
+`GIT_SEQUENCE_EDITOR`::
54
Text editor used to edit the 'todo' file while running `git rebase
55
-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`.
59
61
-GIT_PAGER::
60
+`GIT_PAGER`::
61
Text viewer for use by Git commands (e.g., 'less'). The value
62
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`).
65
ifdef::git-default-pager[]
66
The build you are using chose '{git-default-pager}' as the default.
67
endif::git-default-pager[]
68
71
-GIT_DEFAULT_BRANCH::
69
+`GIT_DEFAULT_BRANCH`::
70
The name of the first branch created in newly initialized repositories.
71
74
-GIT_SHELL_PATH::
72
+`GIT_SHELL_PATH`::
73
The path of the binary providing the POSIX shell for commands which use the shell.
74
77
-GIT_ATTR_SYSTEM::
75
+`GIT_ATTR_SYSTEM`::
76
The path to the system linkgit:gitattributes[5] file, if one is enabled.
77
80
-GIT_ATTR_GLOBAL::
78
+`GIT_ATTR_GLOBAL`::
79
The path to the global (per-user) linkgit:gitattributes[5] file.
80
83
-GIT_CONFIG_SYSTEM::
81
+`GIT_CONFIG_SYSTEM`::
82
The path to the system configuration file, if one is enabled.
83
86
-GIT_CONFIG_GLOBAL::
84
+`GIT_CONFIG_GLOBAL`::
85
The path to the global (per-user) configuration files, if any.
86
87
Most path values contain only one value. However, some can contain multiple