]> granicus.if.org Git - git/commitdiff
git-help.txt: document "git help cmd" vs "git cmd --help" for aliases
authorRasmus Villemoes <rv@rasmusvillemoes.dk>
Tue, 9 Oct 2018 11:59:09 +0000 (13:59 +0200)
committerJunio C Hamano <gitster@pobox.com>
Thu, 11 Oct 2018 01:21:44 +0000 (10:21 +0900)
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>
Documentation/git-help.txt

index 83d25d825aa5a9b68f3cff5290d1ebacef35ebde..86a6b42345d79eaa45da5b6e4c4f279eff4d39d5 100644 (file)
@@ -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.