[PATCH v3 3/3] git-help.txt: document "git help cmd" vs "git cmd --help" for aliases

From: Rasmus Villemoes <rv@rasmusvillemoes.dk>
Date: Oct 3, 2018, 11:42 UTC
Message-ID: <20181003114242.9858-4-rv@rasmusvillemoes.dk>
In-Reply-To: <20181003114242.9858-1-rv@rasmusvillemoes.dk>

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

-- 
2.19.0