diff options
| author |  Jonathan Nieder <jrnieder@gmail.com> | 2012-03-31 03:42:34 -0500 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2012-03-31 11:14:26 -0700 |
| commit | 4e0ce4dfea869cfe383149a3db5a430f0579c3f4 (patch) | |
| tree | 1e78053f79b0cfe78d5c103000a5885f13798f03 /Documentation/git-var.txt | |
| parent | Git 1.7.9 (diff) | |
| download | tgif-4e0ce4dfea869cfe383149a3db5a430f0579c3f4.tar.xz | |
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) <linux@rodrigosilva.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-var.txt')
| -rw-r--r-- | Documentation/git-var.txt | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt index 5317cc2474..beef9e285d 100644 --- a/Documentation/git-var.txt +++ b/Documentation/git-var.txt @@ -43,13 +43,15 @@ GIT_EDITOR:: `$SOME_ENVIRONMENT_VARIABLE`, `"C:\Program Files\Vim\gvim.exe" --nofork`. The order of preference is the `$GIT_EDITOR` environment variable, then `core.editor` configuration, then - `$VISUAL`, then `$EDITOR`, and then finally 'vi'. + `$VISUAL`, then `$EDITOR`, and then the default chosen at compile + time, which is usually 'vi'. GIT_PAGER:: 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 the `$GIT_PAGER` environment variable, then `core.pager` - configuration, then `$PAGER`, and then finally 'less'. + configuration, then `$PAGER`, and then the default chosen at + compile time (usually 'less'). Diagnostics ----------- |