summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Rasmus Villemoes <rv@rasmusvillemoes.dk>2018-10-09 13:59:09 +0200
committerLibravatar Junio C Hamano <gitster@pobox.com>2018-10-11 10:21:44 +0900
commit912104770d1b3b009a58e95ae57f6db65791b031 (patch)
tree999db0780bd75db36cbc030066d098bdf6a6ce36
parentgit.c: handle_alias: prepend alias info when first argument is -h (diff)
downloadtgif-912104770d1b3b009a58e95ae57f6db65791b031.tar.xz
git-help.txt: document "git help cmd" vs "git cmd --help" for aliases
This documents the existing behaviour of "git help cmd" when cmd is an alias, as well as providing a hint to use the "git cmd --help" form to be taken directly to the man page for the aliased command. Signed-off-by: Rasmus Villemoes <rv@rasmusvillemoes.dk> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/git-help.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 83d25d825a..86a6b42345 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -29,6 +29,10 @@ guide is brought up. The 'man' program is used by default for this
purpose, but this can be overridden by other options or configuration
variables.
+If an alias is given, git shows the definition of the alias on
+standard output. To get the manual page for the aliased command, use
+`git COMMAND --help`.
+
Note that `git --help ...` is identical to `git help ...` because the
former is internally converted into the latter.