Re: [PATCH v2 2/3] help: introduce option --exclude-guides
From: Junio C Hamano <hidden>
Date: 2016-08-26 19:44:55
Junio C Hamano [off-list ref] writes:
Let's hide this option from command help of "git help" itself, drop the short-and-sweet "-e", not command-line complete it, and leave it not-mentioned here. ... Unless there is a good reason you MUST do so, avoid quoting the test body with double quotes, as it invites mistakes [*1*]. Also, how about using something like: ... instead? That way, you can ensure that "git help status" attempts to call git-status.html with the expected path, not gitstatus.html or status.html, or somesuch, immediately after running "git help status" in the next test by inspecting test-browser.log ...
Taking all of these together, I'll queue this as a proposed fix-up directly on top of yours. Documentation/git-help.txt | 6 +----- builtin/help.c | 2 +- contrib/completion/git-completion.bash | 2 +- t/t0012-help.sh | 33 ++++++++++++++++++--------------- 4 files changed, 21 insertions(+), 22 deletions(-)
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index eeb1950..40d328a 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] [-e|--exclude-guides] [-g|--guide] +'git help' [-a|--all] [-g|--guide] [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE] DESCRIPTION
@@ -43,10 +43,6 @@ 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 40901a9..49f7a07 100644
--- a/builtin/help.c
+++ b/builtin/help.c@@ -40,7 +40,7 @@ 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_HIDDEN_BOOL(0, "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"),
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index 63cccb9..bd25b0a 100644
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash@@ -1340,7 +1340,7 @@ _git_help () { case "$cur" in --*) - __gitcomp "--all --exclude-guides --guides --info --man --web" + __gitcomp "--all --guides --info --man --web" return ;; esac
diff --git a/t/t0012-help.sh b/t/t0012-help.sh
index f91088b..9d99812 100755
--- a/t/t0012-help.sh
+++ b/t/t0012-help.sh@@ -7,27 +7,30 @@ test_description='help' configure_help () { test_config help.format html && test_config help.htmlpath test://html && - test_config help.browser firefox + test_config browser.test.cmd ./test-browser && + test_config help.browser test } -test_expect_success "setup" " - write_script firefox <<-\EOF - exit 0 +test_expect_success "setup" ' + write_script test-browser <<-\EOF + echo "$*" >test-browser.log EOF -" +' -test_expect_success "works for commands and guides by default" " +test_expect_success "works for commands and guides by default" ' configure_help && git help status && - git help revisions -" + echo "test://html/git-status.html" >expect && + test_cmp expect test-browser.log && + git help revisions && + echo "test://html/gitrevisions.html" >expect && + test_cmp expect test-browser.log +' -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_expect_success "--exclude-guides does not work for guides" ' + >test-browser.log && + test_must_fail git help --exclude-guides revisions && + test_must_be_empty test-browser.log +' test_done
--
2.10.0-rc1-260-gbdd1a2a