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

[PATCH] help: show manpage for aliased command on git <alias> --help

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Mar 5, 2013, 14:44 UTC
Message-ID
<1362494681-11419-1-git-send-email-avarab@gmail.com>

Change the semantics of "git <alias> --help" to show the help for the command <alias> is aliased to, instead of just saying:

    `git <alias>' is aliased to `<whatever>'
E.g. if you have "checkout" aliased to "co" you won't get:
    $ git co --help
    `git co' is aliased to `checkout'

But will instead get the manpage for git-checkout. The behavior this is replacing was originally added by Jeff King in 2156435. I'm changing it because of this off-the-cuff comment on IRC:

    14:27:43 <@Tux> git can be very unhelpful, literally:
    14:27:46 <@Tux> $ git co --help
    14:27:46 <@Tux> `git co' is aliased to `checkout'
    14:28:08 <@Tux> I know!, gimme the help for checkout, please

And because I also think it makes more sense than showing you what the thing is aliased to.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 builtin/help.c |   12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/builtin/help.c b/builtin/help.c
index d1d7181..fdb3312 100644
--- a/builtin/help.c
+++ b/builtin/help.c
@@ -417,6 +417,7 @@ int cmd_help(int argc, const char **argv, const char *prefix)
 {
 	int nongit;
 	const char *alias;
+	const char *show_help_for;
 	enum help_format parsed_help_format;
 	load_command_list("git-", &main_cmds, &other_cmds);
 
@@ -449,20 +450,21 @@ int cmd_help(int argc, const char **argv, const char *prefix)
 
 	alias = alias_lookup(argv[0]);
 	if (alias && !is_git_command(argv[0])) {
-		printf_ln(_("`git %s' is aliased to `%s'"), argv[0], alias);
-		return 0;
+		show_help_for = alias;
+	} else {
+		show_help_for = argv[0];
 	}
 
 	switch (help_format) {
 	case HELP_FORMAT_NONE:
 	case HELP_FORMAT_MAN:
-		show_man_page(argv[0]);
+		show_man_page(show_help_for);
 		break;
 	case HELP_FORMAT_INFO:
-		show_info_page(argv[0]);
+		show_info_page(show_help_for);
 		break;
 	case HELP_FORMAT_WEB:
-		show_html_page(argv[0]);
+		show_html_page(show_help_for);
 		break;
 	}
 
-- 
1.7.10.4
Next: Johannes Sixt
Message 1 of 10 in “help: show manpage for aliased command on git <alias> --help”
  1. help: show manpage for aliased command on git <alias> --helpÆvar Arnfjörð Bjarmason, Mar 5, 2013
  2. Johannes SixtMar 5, 2013
  3. H.Merijn BrandMar 5, 2013
  4. Matthieu MoyMar 5, 2013
  5. Junio C HamanoMar 5, 2013
  6. Ævar Arnfjörð BjarmasonMar 5, 2013
  7. Junio C HamanoMar 5, 2013
  8. Jeff KingMar 5, 2013
  9. Michael J GruberMar 6, 2013
  10. Junio C HamanoMar 6, 2013

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.