[PATCH 1/2] help: introduce option --command-only
From: Ralf Thielow <hidden>
Date: 2016-08-19 01:14:46
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Possibly related (same subject, not in this thread)
- 2016-08-19 · Re: [PATCH 1/2] help: introduce option --command-only · Junio C Hamano <hidden>
Introduce option --command-only to the help command. With this option being passed, "git help" will open man pages only for commands. Since we know it is a command, we can use function help_unknown_command to give the user advice on typos. Signed-off-by: Ralf Thielow <redacted> --- I am not sure about the first test case, but I think it'd have prevented me from making earlier mistakes of this change. That's why I added it. Just calling a git command that succeeds in a test isn't really a check, so ... I dunno Documentation/git-help.txt | 11 ++++++++--- builtin/help.c | 30 +++++++++++++++++++++++------- contrib/completion/git-completion.bash | 2 +- t/t0012-help.sh | 21 +++++++++++++++++++++ 4 files changed, 53 insertions(+), 11 deletions(-) create mode 100755 t/t0012-help.sh
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 40d328a..cf6a414 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt@@ -8,7 +8,7 @@ git-help - Display help information about Git SYNOPSIS -------- [verse] -'git help' [-a|--all] [-g|--guide] +'git help' [-a|--all] [-c|--command-only] [-g|--guide] [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE] DESCRIPTION
@@ -29,8 +29,9 @@ 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. -Note that `git --help ...` is identical to `git help ...` because the -former is internally converted into the latter. +Note that `git --help ...` is almost identical to `git help ...` because +the former is internally converted into the latter with option --command-only +being added. To display the linkgit:git[1] man page, use `git help git`.
@@ -43,6 +44,10 @@ OPTIONS Prints all the available commands on the standard output. This option overrides any given command or guide name. +-c:: +--command-only:: + Display help information only for commands. + -g:: --guides:: Prints a list of useful guides on the standard output. This
diff --git a/builtin/help.c b/builtin/help.c
index 8848013..2249a67 100644
--- a/builtin/help.c
+++ b/builtin/help.c@@ -37,8 +37,10 @@ static int show_all = 0; static int show_guides = 0; static unsigned int colopts; static enum help_format help_format = HELP_FORMAT_NONE; +static int cmd_only; static struct option builtin_help_options[] = { OPT_BOOL('a', "all", &show_all, N_("print all available commands")), + OPT_BOOL('c', "command-only", &cmd_only, N_("show help only for commands")), OPT_BOOL('g', "guides", &show_guides, N_("print list of useful guides")), OPT_SET_INT('m', "man", &help_format, N_("show man page"), HELP_FORMAT_MAN), OPT_SET_INT('w', "web", &help_format, N_("show manual in web browser"),
@@ -433,10 +435,29 @@ static void list_common_guides_help(void) putchar('\n'); } +static const char *check_git_cmd(const char* cmd) +{ + char *alias; + + if (is_git_command(cmd)) + return cmd; + + alias = alias_lookup(cmd); + if (alias) { + printf_ln(_("`git %s' is aliased to `%s'"), cmd, alias); + free(alias); + exit(0); + } + + if (cmd_only) + return help_unknown_cmd(cmd); + + return cmd; +} + int cmd_help(int argc, const char **argv, const char *prefix) { int nongit; - char *alias; enum help_format parsed_help_format; argc = parse_options(argc, argv, prefix, builtin_help_options,
@@ -476,12 +497,7 @@ int cmd_help(int argc, const char **argv, const char *prefix) if (help_format == HELP_FORMAT_NONE) help_format = parse_help_format(DEFAULT_HELP_FORMAT); - alias = alias_lookup(argv[0]); - if (alias && !is_git_command(argv[0])) { - printf_ln(_("`git %s' is aliased to `%s'"), argv[0], alias); - free(alias); - return 0; - } + argv[0] = check_git_cmd(argv[0]); switch (help_format) { case HELP_FORMAT_NONE:
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index c1b2135..354afe5 100644
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash@@ -1393,7 +1393,7 @@ _git_help () { case "$cur" in --*) - __gitcomp "--all --guides --info --man --web" + __gitcomp "--all --command-only --guides --info --man --web" return ;; esac
diff --git a/t/t0012-help.sh b/t/t0012-help.sh
new file mode 100755
index 0000000..e20f907
--- /dev/null
+++ b/t/t0012-help.sh@@ -0,0 +1,21 @@ +#!/bin/sh + +test_description='help' + +. ./test-lib.sh + +test_expect_success "works for commands and guides by default" " + git help status && + git help revisions +" + +test_expect_success "--command-only does not work for guides" " + git help --command-only status && + cat <<-EOF >expected && + git: 'revisions' is not a git command. See 'git --help'. + EOF + (git help --command-only revisions 2>actual || true) && + test_i18ncmp expected actual +" + +test_done
--
2.9.2.912.gd0c0e83