[PATCH] completion: move private shopt shim for zsh to __git_ namespace

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Apr 27, 2011, 21:27 UTC
Message-ID: <20110427212704.GB18596@elie>
In-Reply-To: <BANLkTikN7iMa_z7wRN8pUS07SMatpyoDPQ@mail.gmail.com>

Most zsh users probably probably do not expect a custom shopt function to enter their environment just because they ran "source ~/.git-completion.sh".

Such namespace pollution makes development of other scripts confusing (because it makes the bash-specific shopt utility seem to be available in zsh) and makes git's tab completion script brittle (since any other shell snippet implementing some other subset of shopt will break it). Rename the shopt shim to the more innocuous __git_shopt to be a good citizen (with two underscores to avoid confusion with completion rules for a hypothetical "git shopt" command).

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Hi,

Felipe Contreras wrote:

Show 12 quoted lines

> +++ b/contrib/completion/git-completion.bash
> @@ -75,6 +75,10 @@
> 
>  if [[ -n ${ZSH_VERSION-} ]]; then
>         autoload -U +X bashcompinit && bashcompinit
> +
> +       # 'words' has special meaning in zsh, and only typeset -h seems to
> +       # override that
> +       alias local="typeset -h"
>  fi
> 
>  case "$COMP_WORDBREAKS" in

The above would change the meaning of "local" in the user's environment and in all shell snippets she sources later. Are you sure that's intended?

Actually the completion script already has a problem along the same lines. Thanks for a reminder.

 contrib/completion/git-completion.bash |   12 ++++++++----
 1 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index 9150ea6..ab95690 100755
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -629,12 +629,12 @@ __git_refs_remotes ()
 __git_remotes ()
 {
 	local i ngoff IFS=$'\n' d="$(__gitdir)"
-	shopt -q nullglob || ngoff=1
-	shopt -s nullglob
+	__git_shopt -q nullglob || ngoff=1
+	__git_shopt -s nullglob
 	for i in "$d/remotes"/*; do
 		echo ${i#$d/remotes/}
 	done
-	[ "$ngoff" ] && shopt -u nullglob
+	[ "$ngoff" ] && __git_shopt -u nullglob
 	for i in $(git --git-dir="$d" config --get-regexp 'remote\..*\.url' 2>/dev/null); do
 		i="${i#remote.}"
 		echo "${i/.url*/}"
@@ -2800,7 +2800,7 @@ complete -o bashdefault -o default -o nospace -F _git git.exe 2>/dev/null \
 fi
 
 if [[ -n ${ZSH_VERSION-} ]]; then
-	shopt () {
+	__git_shopt () {
 		local option
 		if [ $# -ne 2 ]; then
 			echo "USAGE: $0 (-q|-s|-u) <option>" >&2
@@ -2823,4 +2823,8 @@ if [[ -n ${ZSH_VERSION-} ]]; then
 			return 1
 		esac
 	}
+else
+	__git_shopt () {
+		shopt "$@"
+	}
 fi

-- 
1.7.5