git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 2/3] git.c: handle_alias: prepend alias info when first argument is -h

From
Jeff King <peff@peff.net>
Date
Oct 3, 2018, 02:16 UTC
Message-ID
<20181003021607.GB20553@sigill.intra.peff.net>
In-Reply-To
<20181001112107.28956-2-rv@rasmusvillemoes.dk>
On Mon, Oct 01, 2018 at 01:21:06PM +0200, Rasmus Villemoes wrote:
Show 30 quoted lines
> 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'
Nicely explained.
Show 14 quoted lines
> diff --git a/git.c b/git.c
> index a6f4b44af5..0211c2d4c0 100644
> --- a/git.c
> +++ b/git.c
> @@ -318,6 +318,9 @@ static int handle_alias(int *argcp, const char ***argv)
>  	alias_command = (*argv)[0];
>  	alias_string = alias_lookup(alias_command);
>  	if (alias_string) {
> +		if (*argcp > 1 && !strcmp((*argv)[1], "-h"))
> +			fprintf_ln(stderr, _("'%s' is aliased to '%s'"),
> +				   alias_command, alias_string);
>  		if (alias_string[0] == '!') {
>  			struct child_process child = CHILD_PROCESS_INIT;
>  			int nongit_ok;
And the implementation makes sense.
-Peff
Previous: Rasmus VillemoesNext: Rasmus Villemoes
Message 24 of 43 in “help: allow redirecting to help for aliased command”
  1. help: allow redirecting to help for aliased commandRasmus Villemoes, Sep 26, 2018
  2. Taylor BlauSep 26, 2018
  3. Duy NguyenSep 26, 2018
  4. Rasmus VillemoesSep 28, 2018
  5. Junio C HamanoSep 26, 2018
  6. Taylor BlauSep 26, 2018
  7. Junio C HamanoSep 26, 2018
  8. Junio C HamanoSep 26, 2018
  9. Taylor BlauSep 26, 2018
  10. Rasmus VillemoesSep 28, 2018
  11. Jeff KingSep 26, 2018
  12. Junio C HamanoSep 26, 2018
  13. Rasmus VillemoesSep 28, 2018
  14. Jeff KingSep 29, 2018
  15. Junio C HamanoSep 29, 2018
  16. Jeff KingSep 30, 2018
  17. Junio C HamanoSep 30, 2018
  18. Jeff KingSep 30, 2018
  19. Rasmus VillemoesSep 28, 2018
  20. Junio C HamanoSep 28, 2018
  21. Duy NguyenSep 26, 2018
  22. 1/3 help: redirect to aliased commands for "git cmd --help"Rasmus Villemoes, Oct 1, 2018
  23. 2/3 git.c: handle_alias: prepend alias info when first argument is -hRasmus Villemoes, Oct 1, 2018
  24. Jeff KingOct 3, 2018
  25. 3/3 git-help.txt: document "git help cmd" vs "git cmd --help" for aliasesRasmus Villemoes, Oct 1, 2018
  26. Jeff KingOct 3, 2018
  27. Rasmus VillemoesOct 3, 2018
  28. Jeff KingOct 3, 2018
  29. Rasmus VillemoesOct 3, 2018
  30. Jeff KingOct 3, 2018
  31. 0/3 alias help tweaksRasmus Villemoes, Oct 3, 2018
  32. 1/3 help: redirect to aliased commands for "git cmd --help"Rasmus Villemoes, Oct 3, 2018
  33. Junio C HamanoOct 5, 2018
  34. Rasmus VillemoesOct 5, 2018
  35. Junio C HamanoOct 5, 2018
  36. 2/3 git.c: handle_alias: prepend alias info when first argument is -hRasmus Villemoes, Oct 3, 2018
  37. 3/3 git-help.txt: document "git help cmd" vs "git cmd --help" for aliasesRasmus Villemoes, Oct 3, 2018
  38. Jeff KingOct 4, 2018
  39. 0/3 alias help tweaksRasmus Villemoes, Oct 9, 2018
  40. 1/3 help: redirect to aliased commands for "git cmd --help"Rasmus Villemoes, Oct 9, 2018
  41. 2/3 git.c: handle_alias: prepend alias info when first argument is -hRasmus Villemoes, Oct 9, 2018
  42. 3/3 git-help.txt: document "git help cmd" vs "git cmd --help" for aliasesRasmus Villemoes, Oct 9, 2018
  43. Junio C HamanoOct 12, 2018

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.