| Message ID | 20181001112107.28956-3-rv@rasmusvillemoes.dk (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v2,1/3] help: redirect to aliased commands for "git cmd --help" | expand |
On Mon, Oct 01, 2018 at 01:21:07PM +0200, Rasmus Villemoes wrote: > 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. Good idea. > diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt > index 83d25d825a..37e85868fd 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 prints a note explaining what it is an alias > +for on standard output. To get the manual page for the aliased > +command, use `git COMMAND --help`. Funny English: "what it is an...". Maybe: If an alias is given, git shows the definition of the alias on standard output. To get the manual page... -Peff
On 2018-10-03 04:18, Jeff King wrote: > On Mon, Oct 01, 2018 at 01:21:07PM +0200, Rasmus Villemoes wrote: > >> >> +If an alias is given, git prints a note explaining what it is an alias >> +for on standard output. To get the manual page for the aliased >> +command, use `git COMMAND --help`. > > Funny English: "what it is an...". Maybe: > > If an alias is given, git shows the definition of the alias on > standard output. To get the manual page... Much better, thanks. Rasmus
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 83d25d825a..37e85868fd 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 prints a note explaining what it is an alias +for 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.
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(+)