var doc: default editor and pager are configurable at build time
authorJonathan Nieder <jrnieder@gmail.com>
Sat, 31 Mar 2012 08:42:34 +0000 (03:42 -0500)
committerJunio C Hamano <gitster@pobox.com>
Sat, 31 Mar 2012 18:14:26 +0000 (11:14 -0700)
commit4e0ce4dfea869cfe383149a3db5a430f0579c3f4
tree1e78053f79b0cfe78d5c103000a5885f13798f03
parent828ea97de486c1693d6e4f2c7347acb50235a85d
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>
Documentation/git-var.txt