{"thread":{"id":"27195","subject":"[PATCH] git-completion: fix zsh support","startedAt":"2011-04-27T01:26:52Z","lastAt":"2011-05-08T10:48:15Z","messageCount":28,"participants":["Felipe Contreras","Jonathan Nieder","Junio C Hamano","John Szakmeister","SZEDER Gábor"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"166426","messageId":"1303867612-15975-1-git-send-email-felipe.contreras@gmail.com","threadId":"27195","inReplyTo":null,"subject":"[PATCH] git-completion: fix zsh support","fromName":"Felipe Contreras","fromEmail":"felipe.contreras@gmail.com","sentAt":"2011-04-27T01:26:52Z","receivedAt":"2011-04-27T01:26:52Z","isPatch":true,"sender":{"key":"felipe.contreras@gmail.com","avatar":"https://avatars.githubusercontent.com/u/8358?v=4"},"body":"It turns out 'words' is a special variable used by zsh completion, and\nit has some strange behavior as we can see.\n\nBetter avoid it.\n\nSigned-off-by: Felipe Contreras \n---\n contrib/completion/git-completion.bash | 66 ++++++++++++++++----------------\n 1 files changed, 33 insertions(+), 33 deletions(-)\n\ndiff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash\nindex b94ff3c..9aae484 100755\n--- a/contrib/completion/git-completion.bash\n+++ b/contrib/completion/git-completion.bash\n@@ -447,8 +447,8 @@ _get_comp_words_by_ref ()\n \t\tprev)\n \t\t\tprev=${words_[$cword_-1]}\n \t\t\t;;\n-\t\twords)\n-\t\t\twords=(\"${words_[@]}\")\n+\t\tcwords)\n+\t\t\tcwords=(\"${words_[@]}\")\n \t\t\t;;\n \t\tcword)\n \t\t\tcword=$cword_\n@@ -468,8 +468,8 @@ _get_comp_words_by_ref ()\n \t\tprev)\n \t\t\tprev=${COMP_WORDS[COMP_CWORD-1]}\n \t\t\t;;\n-\t\twords)\n-\t\t\twords=(\"${COMP_WORDS[@]}\")\n+\t\tcwords)\n+\t\t\tcwords=(\"${COMP_WORDS[@]}\")\n \t\t\t;;\n \t\tcword)\n \t\t\tcword=$COMP_CWORD\n@@ -739,12 +739,12 @@ __git_complete_revlist ()\n \n __git_complete_remote_or_refspec ()\n {\n-\tlocal cur words cword\n-\t_get_comp_words_by_ref -n =: cur words cword\n-\tlocal cmd=\"${words[1]}\"\n+\tlocal cur cwords cword\n+\t_get_comp_words_by_ref -n =: cur cwords cword\n+\tlocal cmd=\"${cwords[1]}\"\n \tlocal i c=2 remote=\"\" pfx=\"\" lhs=1 no_complete_refspec=0\n \twhile [ $c -lt $cword ]; do\n-\t\ti=\"${words[c]}\"\n+\t\ti=\"${cwords[c]}\"\n \t\tcase \"$i\" in\n \t\t--mirror) [ \"$cmd\" = \"push\" ] && no_complete_refspec=1 ;;\n \t\t--all)\n@@ -991,10 +991,10 @@ __git_aliased_command ()\n # __git_find_on_cmdline requires 1 argument\n __git_find_on_cmdline ()\n {\n-\tlocal word subcommand c=1 words cword\n-\t_get_comp_words_by_ref -n =: words cword\n+\tlocal word subcommand c=1 cwords cword\n+\t_get_comp_words_by_ref -n =: cwords cword\n \twhile [ $c -lt $cword ]; do\n-\t\tword=\"${words[c]}\"\n+\t\tword=\"${cwords[c]}\"\n \t\tfor subcommand in $1; do\n \t\t\tif [ \"$subcommand\" = \"$word\" ]; then\n \t\t\t\techo \"$subcommand\"\n@@ -1007,10 +1007,10 @@ __git_find_on_cmdline ()\n \n __git_has_doubledash ()\n {\n-\tlocal c=1 words cword\n-\t_get_comp_words_by_ref -n =: words cword\n+\tlocal c=1 cwords cword\n+\t_get_comp_words_by_ref -n =: cwords cword\n \twhile [ $c -lt $cword ]; do\n-\t\tif [ \"--\" = \"${words[c]}\" ]; then\n+\t\tif [ \"--\" = \"${cwords[c]}\" ]; then\n \t\t\treturn 0\n \t\tfi\n \t\tc=$((++c))\n@@ -1135,11 +1135,11 @@ _git_bisect ()\n \n _git_branch ()\n {\n-\tlocal i c=1 only_local_ref=\"n\" has_r=\"n\" cur words cword\n+\tlocal i c=1 only_local_ref=\"n\" has_r=\"n\" cur cwords cword\n \n-\t_get_comp_words_by_ref -n =: cur words cword\n+\t_get_comp_words_by_ref -n =: cur cwords cword\n \twhile [ $c -lt $cword ]; do\n-\t\ti=\"${words[c]}\"\n+\t\ti=\"${cwords[c]}\"\n \t\tcase \"$i\" in\n \t\t-d|-m)\tonly_local_ref=\"y\" ;;\n \t\t-r)\thas_r=\"y\" ;;\n@@ -1167,9 +1167,9 @@ _git_branch ()\n \n _git_bundle ()\n {\n-\tlocal words cword\n-\t_get_comp_words_by_ref -n =: words cword\n-\tlocal cmd=\"${words[2]}\"\n+\tlocal cwords cword\n+\t_get_comp_words_by_ref -n =: cwords cword\n+\tlocal cmd=\"${cwords[2]}\"\n \tcase \"$cword\" in\n \t2)\n \t\t__gitcomp \"create list-heads verify unbundle\"\n@@ -1713,15 +1713,15 @@ _git_notes ()\n {\n \tlocal subcommands='add append copy edit list prune remove show'\n \tlocal subcommand=\"$(__git_find_on_cmdline \"$subcommands\")\"\n-\tlocal cur words cword\n-\t_get_comp_words_by_ref -n =: cur words cword\n+\tlocal cur cwords cword\n+\t_get_comp_words_by_ref -n =: cur cwords cword\n \n \tcase \"$subcommand,$cur\" in\n \t,--*)\n \t\t__gitcomp '--ref'\n \t\t;;\n \t,*)\n-\t\tcase \"${words[cword-1]}\" in\n+\t\tcase \"${cwords[cword-1]}\" in\n \t\t--ref)\n \t\t\t__gitcomp \"$(__git_refs)\"\n \t\t\t;;\n@@ -1749,7 +1749,7 @@ _git_notes ()\n \tprune,*)\n \t\t;;\n \t*)\n-\t\tcase \"${words[cword-1]}\" in\n+\t\tcase \"${cwords[cword-1]}\" in\n \t\t-m|-F)\n \t\t\t;;\n \t\t*)\n@@ -1893,11 +1893,11 @@ _git_stage ()\n \n __git_config_get_set_variables ()\n {\n-\tlocal words cword\n-\t_get_comp_words_by_ref -n =: words cword\n+\tlocal cwords cword\n+\t_get_comp_words_by_ref -n =: cwords cword\n \tlocal prevword word config_file= c=$cword\n \twhile [ $c -gt 1 ]; do\n-\t\tword=\"${words[c]}\"\n+\t\tword=\"${cwords[c]}\"\n \t\tcase \"$word\" in\n \t\t--global|--system|--file=*)\n \t\t\tconfig_file=\"$word\"\n@@ -2665,10 +2665,10 @@ _git_svn ()\n _git_tag ()\n {\n \tlocal i c=1 f=0\n-\tlocal words cword prev\n-\t_get_comp_words_by_ref -n =: words cword prev\n+\tlocal cwords cword prev\n+\t_get_comp_words_by_ref -n =: cwords cword prev\n \twhile [ $c -lt $cword ]; do\n-\t\ti=\"${words[c]}\"\n+\t\ti=\"${cwords[c]}\"\n \t\tcase \"$i\" in\n \t\t-d|-v)\n \t\t\t__gitcomp \"$(__git_tags)\"\n@@ -2712,10 +2712,10 @@ _git ()\n \t\tsetopt KSH_TYPESET\n \tfi\n \n-\tlocal cur words cword\n-\t_get_comp_words_by_ref -n =: cur words cword\n+\tlocal cur cwords cword\n+\t_get_comp_words_by_ref -n =: cur cwords cword\n \twhile [ $c -lt $cword ]; do\n-\t\ti=\"${words[c]}\"\n+\t\ti=\"${cwords[c]}\"\n \t\tcase \"$i\" in\n \t\t--git-dir=*) __git_dir=\"${i#--git-dir=}\" ;;\n \t\t--bare) __git_dir=\".\" ;;\n-- \n1.7.5\n"},{"id":"166427","messageId":"20110427013534.GA14286@elie","threadId":"27195","inReplyTo":"1303867612-15975-1-git-send-email-felipe.contreras@gmail.com","subject":"Re: [PATCH] git-completion: fix zsh support","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2011-04-27T01:35:59Z","receivedAt":"2011-04-27T01:35:59Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Felipe Contreras wrote:\n\n> It turns out 'words' is a special variable used by zsh completion, and\n> it has some strange behavior as we can see.\n> \n> Better avoid it.\n\nHoorah! I imagine this fixes a regression introduced by\nv1.7.4-rc0~11^2~2 (bash: get --pretty=m completion to work with\nbash v4, 2010-12-02).\n\n Acked-by: Jonathan Nieder \n\n>\n> Signed-off-by: Felipe Contreras \n> ---\n> contrib/completion/git-completion.bash | 66 ++++++++++++++++----------------\n> 1 files changed, 33 insertions(+), 33 deletions(-)\n\nStefan and Mark, if you'd like to try this out, the patch is at\nhttp://download.gmane.org/gmane.comp.version-control.git/172142/172143\n\nHappily,\nJonathan\n"},{"id":"166428","messageId":"BANLkTi=9PPJWX-y2YuFt3k0op2TaJ54=pw@mail.gmail.com","threadId":"27195","inReplyTo":"20110427013534.GA14286@elie","subject":"Re: [PATCH] git-completion: fix zsh support","fromName":"Felipe Contreras","fromEmail":"felipe.contreras@gmail.com","sentAt":"2011-04-27T01:42:34Z","receivedAt":"2011-04-27T01:42:34Z","isPatch":true,"sender":{"key":"felipe.contreras@gmail.com","avatar":"https://avatars.githubusercontent.com/u/8358?v=4"},"body":"On Wed, Apr 27, 2011 at 4:35 AM, Jonathan Nieder wrote:\n> Felipe Contreras wrote:\n>\n>> It turns out 'words' is a special variable used by zsh completion, and\n>> it has some strange behavior as we can see.\n>>\n>> Better avoid it.\n>\n> Hoorah!  I imagine this fixes a regression introduced by\n> v1.7.4-rc0~11^2~2 (bash: get --pretty=m completion to work with\n> bash v4, 2010-12-02).\n>\n>  Acked-by: Jonathan Nieder \n\nYeap... The completion wasn't working at all after that :(\n\n-- \nFelipe Contreras\n"},{"id":"166440","messageId":"20110427022117.GA16697@elie","threadId":"27195","inReplyTo":"1303867612-15975-1-git-send-email-felipe.contreras@gmail.com","subject":"Re: [PATCH] git-completion: fix zsh support","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2011-04-27T02:21:17Z","receivedAt":"2011-04-27T02:21:17Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Felipe Contreras wrote:\n\n> +++ b/contrib/completion/git-completion.bash\n[...]\n> @@ -739,12 +739,12 @@ __git_complete_revlist ()\n> \n> __git_complete_remote_or_refspec ()\n> {\n> -\tlocal cur words cword\n> -\t_get_comp_words_by_ref -n =: cur words cword\n> -\tlocal cmd=\"${words[1]}\"\n> +\tlocal cur cwords cword\n> +\t_get_comp_words_by_ref -n =: cur cwords cword\n\nHmm, on second thought, this will break the following case, in bash:\n\n\t. /etc/bash_completion;\t# defines _get_comp_words_by_ref\n\t. contrib/completion/git-completion.bash\n\nNot sure how to salvage that. Maybe we need a git-specific API\nthat wraps _get_comp_words_by_ref when the latter is available.\n\n\tif type _get_comp_words_by_ref >/dev/null 2>&1; then\n\t\t_git_get_comp_words_by_ref () {\n\t\t\t_get_comp_words_by_ref \"$@\"\n\t\t\tif test \"${words+set}\"\n\t\t\tthen\n\t\t\t\tcword=\"${words[@]}\"\n\t\t\tfi\n\t\t}\n\telse\n\t\t_git_get_comp_words_by_ref () {\n\t\t\t...\n\t\t}\n\tfi\n"},{"id":"166450","messageId":"7v62q0b8e0.fsf@alter.siamese.dyndns.org","threadId":"27195","inReplyTo":"20110427013534.GA14286@elie","subject":"Re: [PATCH] git-completion: fix zsh support","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2011-04-27T04:55:35Z","receivedAt":"2011-04-27T04:55:35Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jonathan Nieder writes:\n\n> Felipe Contreras wrote:\n>\n>> It turns out 'words' is a special variable used by zsh completion, and\n>> it has some strange behavior as we can see.\n>> \n>> Better avoid it.\n>\n> Hoorah! I imagine this fixes a regression introduced by\n> v1.7.4-rc0~11^2~2 (bash: get --pretty=m completion to work with\n> bash v4, 2010-12-02).\n>\n> Acked-by: Jonathan Nieder \n\nI'd love to share the enthusiasm, but find that \"as we can see\" needs a\nmuch more clarification.\n"},{"id":"166462","messageId":"20110427064033.GB4226@elie","threadId":"27195","inReplyTo":"7v62q0b8e0.fsf@alter.siamese.dyndns.org","subject":"[RFC/PATCH] completion: avoid \"words\" as variable name for zsh portability","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2011-04-27T06:40:34Z","receivedAt":"2011-04-27T06:40:34Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"The \"_get_comp_words_by_ref -n := words\" command from the\nbash_completion library reassembles a modified version of COMP_WORDS\nwith ':' and '=' no longer treated as word separators and stores it in\nthe ${words[@]} array. Git's programmable tab completion script uses\nthis to abstract away the difference between bash v3's and bash v4's\ndefinitions of COMP_WORDS (bash v3 used shell words, while bash v4\nbreaks at separator characters); see v1.7.4-rc0~11^2~2 (bash: get\n--pretty=m completion to work with bash v4, 2010-12-02).\n\nzsh has (or rather its completion functions have) another idea about\nwhat ${words[@]} should contain: the array is prepopulated with the\nwords from the command it is completing. For reasons that are not\nwell understood, when git-completion.bash reserves its own \"words\"\nvariable with \"local words\", the variable becomes empty and cannot be\nchanged from then on. So the completion script neglects the arguments\nit has seen, and words complete like git subcommand names. For\nexample, typing \"git log origi\" gives no completions because\nthere are no \"git origi...\" commands.\n\nWork around this by using a different variable (comp_words) that is\nnot special to zsh. So now commands that completed correctly before\nv1.7.4-rc0~11^2~2 on zsh should be able to complete correctly again.\n\nReported-by: Stefan Haller \nSuggested-by: Felipe Contreras \nSigned-off-by: Jonathan Nieder \n---\nJunio C Hamano wrote:\n\n> I'd love to share the enthusiasm, but find that \"as we can see\" needs a\n> much more clarification.\n\nSorry, I got carried away (I am happy to see someone has made some\nheadway in investigating this old bug). How about this?\n\nThere is still a \"for unknown reasons\" in the above explanation.\n\n contrib/completion/git-completion.bash | 68 ++++++++++++++++---------------\n 1 files changed, 35 insertions(+), 33 deletions(-)\n\ndiff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash\nindex 9150ea6..ce6b3e4 100755\n--- a/contrib/completion/git-completion.bash\n+++ b/contrib/completion/git-completion.bash\n@@ -447,8 +447,9 @@ _get_comp_words_by_ref ()\n \t\tprev)\n \t\t\tprev=${words_[$cword_-1]}\n \t\t\t;;\n-\t\twords)\n-\t\t\twords=(\"${words_[@]}\")\n+\t\t-w)\n+\t\t\teval $2'=(\"${words_[@]}\")'\n+\t\t\tshift\n \t\t\t;;\n \t\tcword)\n \t\t\tcword=$cword_\n@@ -468,8 +469,9 @@ _get_comp_words_by_ref ()\n \t\tprev)\n \t\t\tprev=${COMP_WORDS[COMP_CWORD-1]}\n \t\t\t;;\n-\t\twords)\n-\t\t\twords=(\"${COMP_WORDS[@]}\")\n+\t\t-w)\n+\t\t\teval $2='(\"${COMP_WORDS[@]}\")'\n+\t\t\tshift\n \t\t\t;;\n \t\tcword)\n \t\t\tcword=$COMP_CWORD\n@@ -739,12 +741,12 @@ __git_complete_revlist ()\n \n __git_complete_remote_or_refspec ()\n {\n-\tlocal cur words cword\n-\t_get_comp_words_by_ref -n =: cur words cword\n-\tlocal cmd=\"${words[1]}\"\n+\tlocal cur comp_words cword\n+\t_get_comp_words_by_ref -n =: -w comp_words cur cword\n+\tlocal cmd=\"${comp_words[1]}\"\n \tlocal i c=2 remote=\"\" pfx=\"\" lhs=1 no_complete_refspec=0\n \twhile [ $c -lt $cword ]; do\n-\t\ti=\"${words[c]}\"\n+\t\ti=\"${comp_words[c]}\"\n \t\tcase \"$i\" in\n \t\t--mirror) [ \"$cmd\" = \"push\" ] && no_complete_refspec=1 ;;\n \t\t--all)\n@@ -991,10 +993,10 @@ __git_aliased_command ()\n # __git_find_on_cmdline requires 1 argument\n __git_find_on_cmdline ()\n {\n-\tlocal word subcommand c=1 words cword\n-\t_get_comp_words_by_ref -n =: words cword\n+\tlocal word subcommand c=1 comp_words cword\n+\t_get_comp_words_by_ref -n =: -w comp_words cword\n \twhile [ $c -lt $cword ]; do\n-\t\tword=\"${words[c]}\"\n+\t\tword=\"${comp_words[c]}\"\n \t\tfor subcommand in $1; do\n \t\t\tif [ \"$subcommand\" = \"$word\" ]; then\n \t\t\t\techo \"$subcommand\"\n@@ -1007,10 +1009,10 @@ __git_find_on_cmdline ()\n \n __git_has_doubledash ()\n {\n-\tlocal c=1 words cword\n-\t_get_comp_words_by_ref -n =: words cword\n+\tlocal c=1 comp_words cword\n+\t_get_comp_words_by_ref -n =: -w comp_words cword\n \twhile [ $c -lt $cword ]; do\n-\t\tif [ \"--\" = \"${words[c]}\" ]; then\n+\t\tif [ \"--\" = \"${comp_words[c]}\" ]; then\n \t\t\treturn 0\n \t\tfi\n \t\tc=$((++c))\n@@ -1135,11 +1137,11 @@ _git_bisect ()\n \n _git_branch ()\n {\n-\tlocal i c=1 only_local_ref=\"n\" has_r=\"n\" cur words cword\n+\tlocal i c=1 only_local_ref=\"n\" has_r=\"n\" cur comp_words cword\n \n-\t_get_comp_words_by_ref -n =: cur words cword\n+\t_get_comp_words_by_ref -n =: -w comp_words cur cword\n \twhile [ $c -lt $cword ]; do\n-\t\ti=\"${words[c]}\"\n+\t\ti=\"${comp_words[c]}\"\n \t\tcase \"$i\" in\n \t\t-d|-m)\tonly_local_ref=\"y\" ;;\n \t\t-r)\thas_r=\"y\" ;;\n@@ -1167,9 +1169,9 @@ _git_branch ()\n \n _git_bundle ()\n {\n-\tlocal words cword\n-\t_get_comp_words_by_ref -n =: words cword\n-\tlocal cmd=\"${words[2]}\"\n+\tlocal comp_words cword\n+\t_get_comp_words_by_ref -n =: -w comp_words cword\n+\tlocal cmd=\"${comp_words[2]}\"\n \tcase \"$cword\" in\n \t2)\n \t\t__gitcomp \"create list-heads verify unbundle\"\n@@ -1713,15 +1715,15 @@ _git_notes ()\n {\n \tlocal subcommands='add append copy edit list prune remove show'\n \tlocal subcommand=\"$(__git_find_on_cmdline \"$subcommands\")\"\n-\tlocal cur words cword\n-\t_get_comp_words_by_ref -n =: cur words cword\n+\tlocal cur comp_words cword\n+\t_get_comp_words_by_ref -n =: -w comp_words cur cword\n \n \tcase \"$subcommand,$cur\" in\n \t,--*)\n \t\t__gitcomp '--ref'\n \t\t;;\n \t,*)\n-\t\tcase \"${words[cword-1]}\" in\n+\t\tcase \"${comp_words[cword-1]}\" in\n \t\t--ref)\n \t\t\t__gitcomp \"$(__git_refs)\"\n \t\t\t;;\n@@ -1749,7 +1751,7 @@ _git_notes ()\n \tprune,*)\n \t\t;;\n \t*)\n-\t\tcase \"${words[cword-1]}\" in\n+\t\tcase \"${comp_words[cword-1]}\" in\n \t\t-m|-F)\n \t\t\t;;\n \t\t*)\n@@ -1893,11 +1895,11 @@ _git_stage ()\n \n __git_config_get_set_variables ()\n {\n-\tlocal words cword\n-\t_get_comp_words_by_ref -n =: words cword\n+\tlocal comp_words cword\n+\t_get_comp_words_by_ref -n =: -w comp_words cword\n \tlocal prevword word config_file= c=$cword\n \twhile [ $c -gt 1 ]; do\n-\t\tword=\"${words[c]}\"\n+\t\tword=\"${comp_words[c]}\"\n \t\tcase \"$word\" in\n \t\t--global|--system|--file=*)\n \t\t\tconfig_file=\"$word\"\n@@ -2665,10 +2667,10 @@ _git_svn ()\n _git_tag ()\n {\n \tlocal i c=1 f=0\n-\tlocal words cword prev\n-\t_get_comp_words_by_ref -n =: words cword prev\n+\tlocal comp_words cword prev\n+\t_get_comp_words_by_ref -n =: -w comp_words cword prev\n \twhile [ $c -lt $cword ]; do\n-\t\ti=\"${words[c]}\"\n+\t\ti=\"${comp_words[c]}\"\n \t\tcase \"$i\" in\n \t\t-d|-v)\n \t\t\t__gitcomp \"$(__git_tags)\"\n@@ -2712,10 +2714,10 @@ _git ()\n \t\tsetopt KSH_TYPESET\n \tfi\n \n-\tlocal cur words cword\n-\t_get_comp_words_by_ref -n =: cur words cword\n+\tlocal cur comp_words cword\n+\t_get_comp_words_by_ref -n =: -w comp_words cur cword\n \twhile [ $c -lt $cword ]; do\n-\t\ti=\"${words[c]}\"\n+\t\ti=\"${comp_words[c]}\"\n \t\tcase \"$i\" in\n \t\t--git-dir=*) __git_dir=\"${i#--git-dir=}\" ;;\n \t\t--bare) __git_dir=\".\" ;;\n-- \n1.7.5\n"},{"id":"166472","messageId":"BANLkTinep961dg9v3TD8hZZAvTYL3_H+xg@mail.gmail.com","threadId":"27195","inReplyTo":"7v62q0b8e0.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH] git-completion: fix zsh support","fromName":"Felipe Contreras","fromEmail":"felipe.contreras@gmail.com","sentAt":"2011-04-27T08:20:42Z","receivedAt":"2011-04-27T08:20:42Z","isPatch":true,"sender":{"key":"felipe.contreras@gmail.com","avatar":"https://avatars.githubusercontent.com/u/8358?v=4"},"body":"On Wed, Apr 27, 2011 at 7:55 AM, Junio C Hamano wrote:\n> Jonathan Nieder writes:\n>\n>> Felipe Contreras wrote:\n>>\n>>> It turns out 'words' is a special variable used by zsh completion, and\n>>> it has some strange behavior as we can see.\n>>>\n>>> Better avoid it.\n>>\n>> Hoorah!  I imagine this fixes a regression introduced by\n>> v1.7.4-rc0~11^2~2 (bash: get --pretty=m completion to work with\n>> bash v4, 2010-12-02).\n>>\n>>  Acked-by: Jonathan Nieder \n>\n> I'd love to share the enthusiasm, but find that \"as we can see\" needs a\n> much more clarification.\n\nJonathan already described it:\nhttp://article.gmane.org/gmane.comp.version-control.git/170665\n\nAnd this snipped demonstrates it:\n---\nset_vars ()\n{\n\tcur=\"foo\"\n\twords=\"foo\"\n\tcwords=\"foo\"\n}\n\n_foo ()\n{\n\tlocal cur words cwords\n\tset_vars\n\n\techo \"cur=${cur} words=${words} cwords=${cwords}\" >> /tmp/comp_test.txt\n}\n\ncompdef _foo foo\n---\n\nWhen trying to auto-complete 'foo' the result would be:\n cur=foo words= cwords=foo\n\nYou can see it's special in the source code:\nhttp://zsh.git.sourceforge.net/git/gitweb.cgi?p=zsh/zsh;a=blob;f=Src/Zle/complete.c;h=6398fd3e77eff2ef819c10503d316b08421034ac;hb=HEAD#l1116\n\n-- \nFelipe Contreras\n"},{"id":"166484","messageId":"BANLkTinA5hfddqpGwOBjk+2oFDpwqORrSg@mail.gmail.com","threadId":"27195","inReplyTo":"20110427064033.GB4226@elie","subject":"Re: [RFC/PATCH] completion: avoid \"words\" as variable name for zsh portability","fromName":"Felipe Contreras","fromEmail":"felipe.contreras@gmail.com","sentAt":"2011-04-27T08:42:28Z","receivedAt":"2011-04-27T08:42:28Z","isPatch":true,"sender":{"key":"felipe.contreras@gmail.com","avatar":"https://avatars.githubusercontent.com/u/8358?v=4"},"body":"On Wed, Apr 27, 2011 at 9:40 AM, Jonathan Nieder wrote:\n>> I'd love to share the enthusiasm, but find that \"as we can see\" needs a\n>> much more clarification.\n>\n> Sorry, I got carried away (I am happy to see someone has made some\n> headway in investigating this old bug).  How about this?\n\nWhat's wrong with my patch?\n\n> There is still a \"for unknown reasons\" in the above explanation.\n\nI'm asking zsh guys:\nhttp://www.zsh.org/mla/workers/2011/msg00515.html\n\n-- \nFelipe Contreras\n"},{"id":"166487","messageId":"20110427091140.GB14849@elie","threadId":"27195","inReplyTo":"BANLkTinA5hfddqpGwOBjk+2oFDpwqORrSg@mail.gmail.com","subject":"Re: [RFC/PATCH] completion: avoid \"words\" as variable name for zsh portability","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2011-04-27T09:11:40Z","receivedAt":"2011-04-27T09:11:40Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Felipe Contreras wrote:\n> On Wed, Apr 27, 2011 at 9:40 AM, Jonathan Nieder wrote:\n\n>> Sorry, I got carried away (I am happy to see someone has made some\n>> headway in investigating this old bug).  How about this?\n>\n> What's wrong with my patch?\n\nAs mentioned at\nhttp://thread.gmane.org/gmane.comp.version-control.git/172142/focus=172157\nit breaks the tab completion in the common case that the user uses\nthe standard bash completion library (usually provided at\n/etc/bash_completion) and git uses its _get_comp_words_by_ref\nfunction. You can test like so:\n\n\t% bash\n\t$ . /etc/bash_completion\n\t$ . contrib/completion/git-completion.bash\n\t$ git fetch origin \n\nI also made a small cosmetic change which is less important (sorry, I\nshould have mentioned it before): the patch I sent spells out\ncomp_words instead of writing cwords to avoid a false analogy between\nthe array of all completion words (cwords) and the current word index\n(cword).\n\n>> There is still a \"for unknown reasons\" in the above explanation.\n>\n> I'm asking zsh guys:\n> http://www.zsh.org/mla/workers/2011/msg00515.html\n\nThanks. It looks like to get the semantics I expect from \"local\"\nin zsh, one needs to use \"typeset -h\" (which bash does not support,\nunfortunately). Probably it is best to steer clear of zsh's special\nvariables anyway.\n"},{"id":"166492","messageId":"BANLkTi=3T2B=Gtyk7V_3DB3V+GkbXAaqPw@mail.gmail.com","threadId":"27195","inReplyTo":"20110427091140.GB14849@elie","subject":"Re: [RFC/PATCH] completion: avoid \"words\" as variable name for zsh portability","fromName":"Felipe Contreras","fromEmail":"felipe.contreras@gmail.com","sentAt":"2011-04-27T09:49:53Z","receivedAt":"2011-04-27T09:49:53Z","isPatch":true,"sender":{"key":"felipe.contreras@gmail.com","avatar":"https://avatars.githubusercontent.com/u/8358?v=4"},"body":"On Wed, Apr 27, 2011 at 12:11 PM, Jonathan Nieder wrote:\n> Felipe Contreras wrote:\n>> On Wed, Apr 27, 2011 at 9:40 AM, Jonathan Nieder wrote:\n>\n>>> Sorry, I got carried away (I am happy to see someone has made some\n>>> headway in investigating this old bug).  How about this?\n>>\n>> What's wrong with my patch?\n>\n> As mentioned at\n> http://thread.gmane.org/gmane.comp.version-control.git/172142/focus=172157\n> it breaks the tab completion in the common case that the user uses\n> the standard bash completion library (usually provided at\n> /etc/bash_completion) and git uses its _get_comp_words_by_ref\n> function.  You can test like so:\n>\n>        % bash\n>        $ . /etc/bash_completion\n>        $ . contrib/completion/git-completion.bash\n>        $ git fetch origin \n\nWhere does that 'bash_completion' file comes from? I don't have it on\nmy system. Do we really need to use _get_comp_words_by_ref from there?\nCan't we have our own _get_comp_words_by_ref?\n\n> I also made a small cosmetic change which is less important (sorry, I\n> should have mentioned it before): the patch I sent spells out\n> comp_words instead of writing cwords to avoid a false analogy between\n> the array of all completion words (cwords) and the current word index\n> (cword).\n\nI don't see how cword can be confused with cwords. Besides, I prefer\nuniformity, so if you use comp_words, cword should be cur_word, or\nword_index, or something like that.\n\n>>> There is still a \"for unknown reasons\" in the above explanation.\n>>\n>> I'm asking zsh guys:\n>> http://www.zsh.org/mla/workers/2011/msg00515.html\n>\n> Thanks.  It looks like to get the semantics I expect from \"local\"\n> in zsh, one needs to use \"typeset -h\" (which bash does not support,\n> unfortunately).  Probably it is best to steer clear of zsh's special\n> variables anyway.\n\nHmm, interesting, maybe we should try to find a way to replace those\n'local' with 'typeset -h'.\n\n-- \nFelipe Contreras\n"},{"id":"166494","messageId":"BANLkTim8ofv63uPutcMJpo1PAVHv7dwVRg@mail.gmail.com","threadId":"27195","inReplyTo":"BANLkTi=3T2B=Gtyk7V_3DB3V+GkbXAaqPw@mail.gmail.com","subject":"Re: [RFC/PATCH] completion: avoid \"words\" as variable name for zsh portability","fromName":"John Szakmeister","fromEmail":"john@szakmeister.net","sentAt":"2011-04-27T09:59:05Z","receivedAt":"2011-04-27T09:59:05Z","isPatch":true,"sender":{"key":"john@szakmeister.net","avatar":"https://avatars.githubusercontent.com/u/448087?v=4"},"body":"On Wed, Apr 27, 2011 at 5:49 AM, Felipe Contreras\n wrote:\n[snip]\n> Where does that 'bash_completion' file comes from? I don't have it on\n> my system. Do we really need to use _get_comp_words_by_ref from there?\n> Can't we have our own _get_comp_words_by_ref?\n\nIt typically comes from the bash-completion package for your system.\nDepending on your distro, it may or may not be there by default. You\ncan get the source from here though:\n \n\n/me goes back to lurking.\n\n-John\n"},{"id":"166495","messageId":"BANLkTikN7iMa_z7wRN8pUS07SMatpyoDPQ@mail.gmail.com","threadId":"27195","inReplyTo":"BANLkTi=3T2B=Gtyk7V_3DB3V+GkbXAaqPw@mail.gmail.com","subject":"Re: [RFC/PATCH] completion: avoid \"words\" as variable name for zsh portability","fromName":"Felipe Contreras","fromEmail":"felipe.contreras@gmail.com","sentAt":"2011-04-27T10:09:28Z","receivedAt":"2011-04-27T10:09:28Z","isPatch":true,"sender":{"key":"felipe.contreras@gmail.com","avatar":"https://avatars.githubusercontent.com/u/8358?v=4"},"body":"On Wed, Apr 27, 2011 at 12:49 PM, Felipe Contreras\n wrote:\n> On Wed, Apr 27, 2011 at 12:11 PM, Jonathan Nieder wrote:\n>> Thanks.  It looks like to get the semantics I expect from \"local\"\n>> in zsh, one needs to use \"typeset -h\" (which bash does not support,\n>> unfortunately).  Probably it is best to steer clear of zsh's special\n>> variables anyway.\n>\n> Hmm, interesting, maybe we should try to find a way to replace those\n> 'local' with 'typeset -h'.\n\nThis seems to do it:\n\n--- a/contrib/completion/git-completion.bash\n+++ b/contrib/completion/git-completion.bash\n@@ -75,6 +75,10 @@\n\n if [[ -n ${ZSH_VERSION-} ]]; then\n autoload -U +X bashcompinit && bashcompinit\n+\n+ # 'words' has special meaning in zsh, and only typeset -h seems to\n+ # override that\n+ alias local=\"typeset -h\"\n fi\n\n case \"$COMP_WORDBREAKS\" in\n\n-- \nFelipe Contreras\n"},{"id":"166527","messageId":"7vzknb8wgd.fsf@alter.siamese.dyndns.org","threadId":"27195","inReplyTo":"BANLkTinep961dg9v3TD8hZZAvTYL3_H+xg@mail.gmail.com","subject":"Re: [PATCH] git-completion: fix zsh support","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2011-04-27T16:56:18Z","receivedAt":"2011-04-27T16:56:18Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Felipe Contreras writes:\n\n> On Wed, Apr 27, 2011 at 7:55 AM, Junio C Hamano wrote:\n> ...\n>> I'd love to share the enthusiasm, but find that \"as we can see\" needs a\n>> much more clarification.\n>\n> Jonathan already described it:\n> http://article.gmane.org/gmane.comp.version-control.git/170665\n>\n> And this snipped demonstrates it:\n> ...\n\nWhen I say \"needs more clarification\" during a review, I am not asking the\ncontributor to explain it in the discussion thread to _me_ who happen to\nbe asking at that moment. I am asking the contributor to explain it to\npeople who will read \"git log\" output 6 months down the road.\n\nYou have been here long enough to know that \"Jonathan already described\nit\" that is not connected in the commit that is going to be recorded is\nnot something we appreciate, no?\n\nIn any case, the message of Jonathan's\n\n Subject: [RFC/PATCH] completion: avoid \"words\" as variable name for zsh portability\n Date: Wed, 27 Apr 2011 01:40:34 -0500\n Message-ID: <20110427064033.GB4226@elie>\n\nseems to explain it better. The naming of variables and other details\nmight need to be settled, but other than that is it correct to understand\nthat we will see a final version along the line of that patch?\n\nThanks.\n"},{"id":"166531","messageId":"BANLkTi=tsgfteYRj8iODZifZuepVCJGq1w@mail.gmail.com","threadId":"27195","inReplyTo":"7vzknb8wgd.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH] git-completion: fix zsh support","fromName":"Felipe Contreras","fromEmail":"felipe.contreras@gmail.com","sentAt":"2011-04-27T17:17:15Z","receivedAt":"2011-04-27T17:17:15Z","isPatch":true,"sender":{"key":"felipe.contreras@gmail.com","avatar":"https://avatars.githubusercontent.com/u/8358?v=4"},"body":"On Wed, Apr 27, 2011 at 7:56 PM, Junio C Hamano wrote:\n> Felipe Contreras writes:\n>\n>> On Wed, Apr 27, 2011 at 7:55 AM, Junio C Hamano wrote:\n>> ...\n>>> I'd love to share the enthusiasm, but find that \"as we can see\" needs a\n>>> much more clarification.\n>>\n>> Jonathan already described it:\n>> http://article.gmane.org/gmane.comp.version-control.git/170665\n>>\n>> And this snipped demonstrates it:\n>> ...\n>\n> When I say \"needs more clarification\" during a review, I am not asking the\n> contributor to explain it in the discussion thread to _me_ who happen to\n> be asking at that moment.  I am asking the contributor to explain it to\n> people who will read \"git log\" output 6 months down the road.\n>\n> You have been here long enough to know that \"Jonathan already described\n> it\" that is not connected in the commit that is going to be recorded is\n> not something we appreciate, no?\n\nHow is one supposed to know when the clarification is sufficient or\nnot? Are you advocating communication through git patches?\n\nI prefer to discuss in the mailing list, and when there's consensus\nfire 'git send-email', that's what they do in lkml.\n\n> In any case, the message of Jonathan's\n>\n>    Subject: [RFC/PATCH] completion: avoid \"words\" as variable name for zsh portability\n>    Date: Wed, 27 Apr 2011 01:40:34 -0500\n>    Message-ID: <20110427064033.GB4226@elie>\n>\n> seems to explain it better.  The naming of variables and other details\n> might need to be settled, but other than that is it correct to understand\n> that we will see a final version along the line of that patch?\n\nI prefer something short, and to the point:\n\n---\ngit-completion: fix zsh support\n\nSupport for zsh was broken on commit da48616f1d[1], due to the fact\nthat 'words' is a is a special variable used by zsh completion[2].\n\nJonathan Nieder found that 'typset -h' resets that special behavior,\nwhich is exactly what we want. So alias the currently used 'local' to\nthat.\n\n[1] http://article.gmane.org/gmane.comp.version-control.git/170665\n[2] http://article.gmane.org/gmane.comp.shells.zsh.devel/22484\n---\n\n-- \nFelipe Contreras\n"},{"id":"166558","messageId":"20110427212704.GB18596@elie","threadId":"27195","inReplyTo":"BANLkTikN7iMa_z7wRN8pUS07SMatpyoDPQ@mail.gmail.com","subject":"[PATCH] completion: move private shopt shim for zsh to __git_ namespace","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2011-04-27T21:27:04Z","receivedAt":"2011-04-27T21:27:04Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Most zsh users probably probably do not expect a custom shopt function\nto enter their environment just because they ran \"source\n~/.git-completion.sh\".\n\nSuch namespace pollution makes development of other scripts confusing\n(because it makes the bash-specific shopt utility seem to be available\nin zsh) and makes git's tab completion script brittle (since any other\nshell snippet implementing some other subset of shopt will break it).\nRename the shopt shim to the more innocuous __git_shopt to be a good\ncitizen (with two underscores to avoid confusion with completion rules\nfor a hypothetical \"git shopt\" command).\n\nSigned-off-by: Jonathan Nieder \n---\nHi,\n\nFelipe Contreras wrote:\n\n> +++ b/contrib/completion/git-completion.bash\n> @@ -75,6 +75,10 @@\n> \n> if [[ -n ${ZSH_VERSION-} ]]; then\n> autoload -U +X bashcompinit && bashcompinit\n> +\n> + # 'words' has special meaning in zsh, and only typeset -h seems to\n> + # override that\n> + alias local=\"typeset -h\"\n> fi\n> \n> case \"$COMP_WORDBREAKS\" in\n\nThe above would change the meaning of \"local\" in the user's\nenvironment and in all shell snippets she sources later. Are you sure\nthat's intended?\n\nActually the completion script already has a problem along the same\nlines. Thanks for a reminder.\n\n contrib/completion/git-completion.bash | 12 ++++++++----\n 1 files changed, 8 insertions(+), 4 deletions(-)\n\ndiff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash\nindex 9150ea6..ab95690 100755\n--- a/contrib/completion/git-completion.bash\n+++ b/contrib/completion/git-completion.bash\n@@ -629,12 +629,12 @@ __git_refs_remotes ()\n __git_remotes ()\n {\n \tlocal i ngoff IFS=$'\\n' d=\"$(__gitdir)\"\n-\tshopt -q nullglob || ngoff=1\n-\tshopt -s nullglob\n+\t__git_shopt -q nullglob || ngoff=1\n+\t__git_shopt -s nullglob\n \tfor i in \"$d/remotes\"/*; do\n \t\techo ${i#$d/remotes/}\n \tdone\n-\t[ \"$ngoff\" ] && shopt -u nullglob\n+\t[ \"$ngoff\" ] && __git_shopt -u nullglob\n \tfor i in $(git --git-dir=\"$d\" config --get-regexp 'remote\\..*\\.url' 2>/dev/null); do\n \t\ti=\"${i#remote.}\"\n \t\techo \"${i/.url*/}\"\n@@ -2800,7 +2800,7 @@ complete -o bashdefault -o default -o nospace -F _git git.exe 2>/dev/null \\\n fi\n \n if [[ -n ${ZSH_VERSION-} ]]; then\n-\tshopt () {\n+\t__git_shopt () {\n \t\tlocal option\n \t\tif [ $# -ne 2 ]; then\n \t\t\techo \"USAGE: $0 (-q|-s|-u)