]> git.ipfire.org Git - thirdparty/git.git/commit - git.c
git.c: handle_alias: prepend alias info when first argument is -h
authorRasmus Villemoes <rv@rasmusvillemoes.dk>
Tue, 9 Oct 2018 11:59:08 +0000 (13:59 +0200)
committerJunio C Hamano <gitster@pobox.com>
Thu, 11 Oct 2018 01:21:43 +0000 (10:21 +0900)
commita9a60b94ccda5ff25faf51f39faeac11cac68346
tree561986a58b5c736b4f5b993a9de882ef2168a991
parente6e76baaf4f0f5bfac5cf5708df536258c28f0f0
git.c: handle_alias: prepend alias info when first argument is -h

Most git commands respond to -h anywhere in the command line, or at
least as a first and lone argument, by printing the usage
information. For aliases, we can provide a little more information that
might be useful in interpreting/understanding the following output by
prepending a line telling that the command is an alias, and for what.

When one invokes a simple alias, such as "cp = cherry-pick"
with -h, this results in

$ git cp -h
'cp' is aliased to 'cherry-pick'
usage: git cherry-pick [<options>] <commit-ish>...
...

When the alias consists of more than one word, this provides the
additional benefit of informing the user which options are implicit in
using the alias, e.g. with "cp = cherry-pick -n":

$ git cp -h
'cp' is aliased to 'cherry-pick -n'
usage: git cherry-pick [<options>] <commit-ish>...
...

For shell commands, we cannot know how it responds to -h, but printing
this line to stderr should not hurt, and can help in figuring out what
is happening in a case like

$ git sc -h
'sc' is aliased to '!somecommand'
somecommand: invalid option '-h'

Suggested-by: Jeff King <peff@peff.net>
Signed-off-by: Rasmus Villemoes <rv@rasmusvillemoes.dk>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
git.c