summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRodrigo Silva (MestreLion) <linux@rodrigosilva.com>2012-03-23 12:38:42 (GMT)
committerJunio C Hamano <gitster@pobox.com>2012-03-26 17:46:07 (GMT)
commit36384c979da7129393462c2208fd156b1453debd (patch)
treefe085e40956d25ca32ca30cf05cfafe61ba3cb8d
parentd3f2475c01d9e90dbadacbe2c35854f6d11e6409 (diff)
downloadgit-36384c979da7129393462c2208fd156b1453debd.zip
git-36384c979da7129393462c2208fd156b1453debd.tar.gz
git-36384c979da7129393462c2208fd156b1453debd.tar.bz2
Documentation: improve description of GIT_EDITOR and preference order
Previously GIT_EDITOR was not listed in git(1) "Environment Variables" section, which could be very confusing to users. Include it in "other" subsection along with a link to git-var(1), since that is the page that fully describes all places where editor can be set and also their preference order. Also, git-var(1) did not say that hardcoded fallback 'vi' may have been changed at build time. A user could be puzzled if 'nano' pops up even when none of the mentioned environment vars or config.editor are set. Clarify this. Ideally, the build system should be changed to reflect the chosen fallback editor when creating the man pages. Not sure if that is even possible though. Signed-off-by: Rodrigo Silva (MestreLion) <linux@rodrigosilva.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/git.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/git.txt b/Documentation/git.txt
index d5b7667..458cc07 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -711,6 +711,12 @@ other
a pager. See also the `core.pager` option in
linkgit:git-config[1].
+'GIT_EDITOR'::
+ This environment variable overrides `$EDITOR` and `$VISUAL`.
+ It is used by several git comands when, on interactive mode,
+ an editor is to be launched. See also linkgit:git-var[1]
+ and the `core.editor` option in linkgit:git-config[1].
+
'GIT_SSH'::
If this environment variable is set then 'git fetch'
and 'git push' will use this command instead