[PATCH v2 2/3] help: introduce option --exclude-guides
From: Ralf Thielow <hidden>
Date: 2016-08-26 17:59:03
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Possibly related (same subject, not in this thread)
- 2016-08-26 · Re: [PATCH v2 2/3] help: introduce option --exclude-guides · Ralf Thielow <hidden>
- 2016-08-26 · Re: [PATCH v2 2/3] help: introduce option --exclude-guides · Junio C Hamano <hidden>
- 2016-08-26 · Re: [PATCH v2 2/3] help: introduce option --exclude-guides · Junio C Hamano <hidden>
- 2016-08-26 · Re: [PATCH v2 2/3] help: introduce option --exclude-guides · Ralf Thielow <hidden>
- 2016-08-26 · Re: [PATCH v2 2/3] help: introduce option --exclude-guides · Ralf Thielow <hidden>
Introduce option --exclude-guides to the help command. With this option being passed, "git help" will open man pages only for actual commands. Since we know it is a command, we can use function help_unknown_command to give the user advice on typos. Helped-by: Johannes Schindelin [off-list ref] Signed-off-by: Ralf Thielow <redacted> --- In the test script we do two things I'd like to point out:
+ test_config help.htmlpath test://html &&
As we pass a URL, Git won't check if the given path looks like a documentation directory. Another solution would be to create a directory, add a file "git.html" to it and just use this path.
+ test_config help.browser firefox
Git checks if the browser is known, so the "test-browser" needs to pretend it is one of them. Documentation/git-help.txt | 6 +++++- builtin/help.c | 30 +++++++++++++++++++++++------- contrib/completion/git-completion.bash | 2 +- t/t0012-help.sh | 33 +++++++++++++++++++++++++++++++++ 4 files changed, 62 insertions(+), 9 deletions(-) create mode 100755 t/t0012-help.sh
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 40d328a..eeb1950 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] [-e|--exclude-guides] [-g|--guide] [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE] DESCRIPTION
@@ -43,6 +43,10 @@ OPTIONS Prints all the available commands on the standard output. This option overrides any given command or guide name. +-e:: +--exclude-guides:: + Do not show help for guides. + -g:: --guides:: Prints a list of useful guides on the standard output. This
diff --git a/builtin/help.c b/builtin/help.c
index e8f79d7..40901a9 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 exclude_guides; static struct option builtin_help_options[] = { OPT_BOOL('a', "all", &show_all, N_("print all available commands")), + OPT_BOOL('e', "exclude-guides", &exclude_guides, N_("exclude guides")), 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"),
@@ -426,10 +428,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 (exclude_guides) + 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,
@@ -469,12 +490,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..b148164 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 --exclude-guides --guides --info --man --web" return ;; esac
diff --git a/t/t0012-help.sh b/t/t0012-help.sh
new file mode 100755
index 0000000..fb1abd7
--- /dev/null
+++ b/t/t0012-help.sh@@ -0,0 +1,33 @@ +#!/bin/sh + +test_description='help' + +. ./test-lib.sh + +configure_help () { + test_config help.format html && + test_config help.htmlpath test://html && + test_config help.browser firefox +} + +test_expect_success "setup" " + write_script firefox <<-\EOF + exit 0 + EOF +" + +test_expect_success "works for commands and guides by default" " + configure_help && + git help status && + git help revisions +" + +test_expect_success "--exclude-guides does not work for guides" " + cat <<-EOF >expected && + git: 'revisions' is not a git command. See 'git --help'. + EOF + test_must_fail git help --exclude-guides revisions 2>actual && + test_i18ncmp expected actual +" + +test_done
--
2.9.2.912.gd0c0e83