Skip to content
This repository was archived by the owner on Nov 9, 2017. It is now read-only.

Commit 4e0ce4d

Browse files
jrngitster
authored andcommitted
var doc: default editor and pager are configurable at build time
Some distributors customize the fallback pager and editor used by git commands when the user has not indicated a preference via the core.editor/core.pager configuration or GIT_EDITOR, GIT_PAGER, VISUAL, EDITOR, and PAGER environment variables, and git's build system provides DEFAULT_PAGER and DEFAULT_EDITOR makefile settings to help them with that (see v1.6.6-rc0~24, 2009-11-20). Unfortunately those compile-time settings do not affect the documentation, so the uninitiated user who tries to understand git by reading the git-var(1) manpage can easily be confused when git falls back to 'nano' and 'more' instead of 'vi' and 'less'. Even if the distributor patches the distributed docs to reflect the new default, the user may read the official documentation from the git-htmldocs repository online and be confused in the same way. Add a few words stating that the defaults are customizable at compile time to make the behavior crystal clear. Reported-by: Rodrigo Silva (MestreLion) <[email protected]> Signed-off-by: Jonathan Nieder <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 828ea97 commit 4e0ce4d

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

Documentation/git-var.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,15 @@ GIT_EDITOR::
4343
`$SOME_ENVIRONMENT_VARIABLE`, `"C:\Program Files\Vim\gvim.exe"
4444
--nofork`. The order of preference is the `$GIT_EDITOR`
4545
environment variable, then `core.editor` configuration, then
46-
`$VISUAL`, then `$EDITOR`, and then finally 'vi'.
46+
`$VISUAL`, then `$EDITOR`, and then the default chosen at compile
47+
time, which is usually 'vi'.
4748

4849
GIT_PAGER::
4950
Text viewer for use by git commands (e.g., 'less'). The value
5051
is meant to be interpreted by the shell. The order of preference
5152
is the `$GIT_PAGER` environment variable, then `core.pager`
52-
configuration, then `$PAGER`, and then finally 'less'.
53+
configuration, then `$PAGER`, and then the default chosen at
54+
compile time (usually 'less').
5355

5456
Diagnostics
5557
-----------

0 commit comments

Comments
 (0)