[v4,3/3] git-help.txt: document "git help cmd" vs "git cmd --help" for aliases
diff mbox series

Message ID 20181009115909.16648-4-rv@rasmusvillemoes.dk
State New
Headers show
  • alias help tweaks
Related show

Commit Message

Rasmus Villemoes Oct. 9, 2018, 11:59 a.m. UTC
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>
 Documentation/git-help.txt | 4 ++++
 1 file changed, 4 insertions(+)

diff mbox series

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
+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.