Skip to content

Commit 13a4232

Browse files
committed
completion: repair config completion for Zsh
Commit 1e0ee40 (completion: add and use __git_compute_first_level_config_vars_for_section, 2024-02-10) uses an indirect variable syntax that is only valid for Bash, but the Zsh completion code relies on the Bash completion code to function. Zsh supports a different indirect variable expansion using ${(P)var}, but in `emulate ksh` mode does not support Bash's ${!var}. This manifests as completing strange config options like "__git_first_level_config_vars_for_section_remote" as a choice for the command line git config set remote. Using Zsh's C-x ? _complete_debug widget with the cursor at the end of that command line captures a trace, in which we see (some details elided): +__git_complete_config_variable_name:7> __git_compute_first_level_config_vars_for_section remote +__git_compute_first_level_config_vars_for_section:7> local section=remote +__git_compute_first_level_config_vars_for_section:7> __git_compute_config_vars +__git_compute_config_vars:7> test -n $'add.ignoreErrors\nadvice.addEmbeddedRepo\nadvice.addEmptyPathspec\nadvice.addIgnoredFile[…]' +__git_compute_first_level_config_vars_for_section:7> local this_section=__git_first_level_config_vars_for_section_remote +__git_compute_first_level_config_vars_for_section:7> test -n __git_first_level_config_vars_for_section_remote +__git_complete_config_variable_name:7> local this_section=__git_first_level_config_vars_for_section_remote +__git_complete_config_variable_name:7> __gitcomp_nl_append __git_first_level_config_vars_for_section_remote remote. '' ' ' +__gitcomp_nl_append:7> __gitcomp_nl __git_first_level_config_vars_for_section_remote remote. '' ' ' +__gitcomp_nl:7> emulate -L zsh +__gitcomp_nl:7> compset -P '*[=:]' +__gitcomp_nl:7> compadd -Q -S ' ' -p remote. -- __git_first_level_config_vars_for_section_remote We perform the test for __git_compute_config_vars correctly, but the ${!this_section} references are not expanded as expected. Instead, portably expand indirect references through the new __git_indirect. Contrary to some versions you might find online [1], this version avoids echo non-portabilities [2] [3] and correctly quotes the indirect expansion after eval (so that the result is not split or globbed before being handed to printf). [1]: https://unix.stackexchange.com/a/41409/301073 [2]: https://askubuntu.com/questions/715765/mysterious-behavior-of-echo-command#comment1056038_715769 [3]: https://mywiki.wooledge.org/CatEchoLs The following demo program demonstrates how this works: b=1 indirect() { eval printf '%s' "\"\$$1\"" } f() { # Comment this out to see that it works for globals, too. Or, use # a value with spaces like '2 3 4' to see how it handles those. local b=2 local a=b test -n "$(indirect $a)" && echo nice } f When placed in a file "demo", then both bash -x demo and zsh -xc 'emulate ksh -c ". ./demo"' |& tail provide traces showing that "$(indirect $a)" produces 2 (or 1, with the global, or "2 3 4" as a single string, etc.). Signed-off-by: D. Ben Knoble <ben.knoble+github@gmail.com> Acked-by: Philippe Blain <levraiphilippeblain@gmail.com>
1 parent 306ab35 commit 13a4232

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

contrib/completion/git-completion.bash

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2737,12 +2737,17 @@ __git_compute_config_vars_all ()
27372737
__git_config_vars_all="$(git --no-pager help --config)"
27382738
}
27392739

2740+
__git_indirect()
2741+
{
2742+
eval printf '%s' "\"\$$1\""
2743+
}
2744+
27402745
__git_compute_first_level_config_vars_for_section ()
27412746
{
27422747
local section="$1"
27432748
__git_compute_config_vars
27442749
local this_section="__git_first_level_config_vars_for_section_${section}"
2745-
test -n "${!this_section}" ||
2750+
test -n "$(__git_indirect "${this_section}")" ||
27462751
printf -v "__git_first_level_config_vars_for_section_${section}" %s \
27472752
"$(echo "$__git_config_vars" | awk -F. "/^${section}\.[a-z]/ { print \$2 }")"
27482753
}
@@ -2752,7 +2757,7 @@ __git_compute_second_level_config_vars_for_section ()
27522757
local section="$1"
27532758
__git_compute_config_vars_all
27542759
local this_section="__git_second_level_config_vars_for_section_${section}"
2755-
test -n "${!this_section}" ||
2760+
test -n "$(__git_indirect "${this_section}")" ||
27562761
printf -v "__git_second_level_config_vars_for_section_${section}" %s \
27572762
"$(echo "$__git_config_vars_all" | awk -F. "/^${section}\.</ { print \$3 }")"
27582763
}
@@ -2907,7 +2912,7 @@ __git_complete_config_variable_name ()
29072912
local section="${pfx%.*.}"
29082913
__git_compute_second_level_config_vars_for_section "${section}"
29092914
local this_section="__git_second_level_config_vars_for_section_${section}"
2910-
__gitcomp "${!this_section}" "$pfx" "$cur_" "$sfx"
2915+
__gitcomp "$(__git_indirect "${this_section}")" "$pfx" "$cur_" "$sfx"
29112916
return
29122917
;;
29132918
branch.*)
@@ -2917,7 +2922,7 @@ __git_complete_config_variable_name ()
29172922
__gitcomp_direct "$(__git_heads "$pfx" "$cur_" ".")"
29182923
__git_compute_first_level_config_vars_for_section "${section}"
29192924
local this_section="__git_first_level_config_vars_for_section_${section}"
2920-
__gitcomp_nl_append "${!this_section}" "$pfx" "$cur_" "${sfx:- }"
2925+
__gitcomp_nl_append "$(__git_indirect "${this_section}")" "$pfx" "$cur_" "${sfx:- }"
29212926
return
29222927
;;
29232928
pager.*)
@@ -2934,7 +2939,7 @@ __git_complete_config_variable_name ()
29342939
__gitcomp_nl "$(__git_remotes)" "$pfx" "$cur_" "."
29352940
__git_compute_first_level_config_vars_for_section "${section}"
29362941
local this_section="__git_first_level_config_vars_for_section_${section}"
2937-
__gitcomp_nl_append "${!this_section}" "$pfx" "$cur_" "${sfx:- }"
2942+
__gitcomp_nl_append "$(__git_indirect "${this_section}")" "$pfx" "$cur_" "${sfx:- }"
29382943
return
29392944
;;
29402945
submodule.*)
@@ -2944,7 +2949,7 @@ __git_complete_config_variable_name ()
29442949
__gitcomp_nl "$(__git config -f "$(__git rev-parse --show-toplevel)/.gitmodules" --get-regexp 'submodule.*.path' | awk -F. '{print $2}')" "$pfx" "$cur_" "."
29452950
__git_compute_first_level_config_vars_for_section "${section}"
29462951
local this_section="__git_first_level_config_vars_for_section_${section}"
2947-
__gitcomp_nl_append "${!this_section}" "$pfx" "$cur_" "${sfx:- }"
2952+
__gitcomp_nl_append "$(__git_indirect "${this_section}")" "$pfx" "$cur_" "${sfx:- }"
29482953
return
29492954
;;
29502955
*.*)

0 commit comments

Comments
 (0)