a9bacccae5
The "help" builtin has been able to emit configuration variables sincee17ca92637(completion: drop the hard coded list of config vars, 2018-05-26), but it hasn't produced exactly the format the completion script wanted. Let's do that. We got partway there in2675ea1cc0(completion: use 'sort -u' to deduplicate config variable names, 2019-08-13) andd9438873c4(completion: deduplicate configuration sections, 2019-08-13), but after both we still needed some sorting, de-duplicating and awk post-processing of the list. We can instead simply do the relevant parsing ourselves (we were doing most of it already), and call string_list_remove_duplicates() after already sorting the list, so the caller doesn't need to invoke "sort -u". The "--config-for-completion" output is the same as before after being passed through "sort -u". Then add a new "--config-sections-for-completion" option. Under that output we'll emit config sections like "alias" (instead of "alias." in the --config-for-completion output). We need to be careful to leave the "--config-for-completion" option compatible with users git, but are still running a shell with an older git-completion.bash. If we e.g. changed the option name they'd see messages about git-completion.bash being unable to find the "--config-for-completion" option. Such backwards compatibility isn't something we should bend over backwards for, it's only helping users who: * Upgrade git * Are in an old shell * The git-completion.bash in that shell hasn't cached the old "--config-for-completion" output already. But since it's easy in this case to retain compatibility, let's do it, the older versions of git-completion.bash won't care that the input they get doesn't change after a "sort -u". While we're at it let's make "--config-for-completion" die if there's anything left over in "argc", and do the same in the new "--config-sections-for-completion" option. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
138 lines
3.5 KiB
Bash
Executable File
138 lines
3.5 KiB
Bash
Executable File
#!/bin/sh
|
|
|
|
test_description='help'
|
|
|
|
. ./test-lib.sh
|
|
|
|
configure_help () {
|
|
test_config help.format html &&
|
|
|
|
# Unless the path has "://" in it, Git tries to make sure
|
|
# the documentation directory locally exists. Avoid it as
|
|
# we are only interested in seeing an attempt to correctly
|
|
# invoke a help browser in this test.
|
|
test_config help.htmlpath test://html &&
|
|
|
|
# Name a custom browser
|
|
test_config browser.test.cmd ./test-browser &&
|
|
test_config help.browser test
|
|
}
|
|
|
|
test_expect_success "setup" '
|
|
# Just write out which page gets requested
|
|
write_script test-browser <<-\EOF
|
|
echo "$*" >test-browser.log
|
|
EOF
|
|
'
|
|
|
|
# make sure to exercise these code paths, the output is a bit tricky
|
|
# to verify
|
|
test_expect_success 'basic help commands' '
|
|
git help >/dev/null &&
|
|
git help -a --no-verbose >/dev/null &&
|
|
git help -g >/dev/null &&
|
|
git help -a >/dev/null
|
|
'
|
|
|
|
test_expect_success 'invalid usage' '
|
|
test_expect_code 129 git help -g add &&
|
|
test_expect_code 129 git help -a -c &&
|
|
|
|
test_expect_code 129 git help -g add &&
|
|
test_expect_code 129 git help -a -g &&
|
|
|
|
test_expect_code 129 git help -g -c &&
|
|
test_expect_code 129 git help --config-for-completion add &&
|
|
test_expect_code 129 git help --config-sections-for-completion add
|
|
'
|
|
|
|
test_expect_success "works for commands and guides by default" '
|
|
configure_help &&
|
|
git help status &&
|
|
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" '
|
|
>test-browser.log &&
|
|
test_must_fail git help --exclude-guides revisions &&
|
|
test_must_be_empty test-browser.log
|
|
'
|
|
|
|
test_expect_success "--help does not work for guides" "
|
|
cat <<-EOF >expect &&
|
|
git: 'revisions' is not a git command. See 'git --help'.
|
|
EOF
|
|
test_must_fail git revisions --help 2>actual &&
|
|
test_cmp expect actual
|
|
"
|
|
|
|
test_expect_success 'git help' '
|
|
git help >help.output &&
|
|
test_i18ngrep "^ clone " help.output &&
|
|
test_i18ngrep "^ add " help.output &&
|
|
test_i18ngrep "^ log " help.output &&
|
|
test_i18ngrep "^ commit " help.output &&
|
|
test_i18ngrep "^ fetch " help.output
|
|
'
|
|
test_expect_success 'git help -g' '
|
|
git help -g >help.output &&
|
|
test_i18ngrep "^ attributes " help.output &&
|
|
test_i18ngrep "^ everyday " help.output &&
|
|
test_i18ngrep "^ tutorial " help.output
|
|
'
|
|
|
|
test_expect_success 'git help -c' '
|
|
git help -c >help.output &&
|
|
cat >expect <<-\EOF &&
|
|
|
|
'\''git help config'\'' for more information
|
|
EOF
|
|
grep -v -E \
|
|
-e "^[^.]+\.[^.]+$" \
|
|
-e "^[^.]+\.[^.]+\.[^.]+$" \
|
|
help.output >actual &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'git help --config-for-completion' '
|
|
git help -c >human &&
|
|
grep -E \
|
|
-e "^[^.]+\.[^.]+$" \
|
|
-e "^[^.]+\.[^.]+\.[^.]+$" human |
|
|
sed -e "s/\*.*//" -e "s/<.*//" |
|
|
sort -u >human.munged &&
|
|
|
|
git help --config-for-completion >vars &&
|
|
test_cmp human.munged vars
|
|
'
|
|
|
|
test_expect_success 'git help --config-sections-for-completion' '
|
|
git help -c >human &&
|
|
grep -E \
|
|
-e "^[^.]+\.[^.]+$" \
|
|
-e "^[^.]+\.[^.]+\.[^.]+$" human |
|
|
sed -e "s/\..*//" |
|
|
sort -u >human.munged &&
|
|
|
|
git help --config-sections-for-completion >sections &&
|
|
test_cmp human.munged sections
|
|
'
|
|
|
|
test_expect_success 'generate builtin list' '
|
|
git --list-cmds=builtins >builtins
|
|
'
|
|
|
|
while read builtin
|
|
do
|
|
test_expect_success "$builtin can handle -h" '
|
|
test_expect_code 129 git $builtin -h >output 2>&1 &&
|
|
test_i18ngrep usage output
|
|
'
|
|
done <builtins
|
|
|
|
test_done
|