completion: don't use __gitdir() for git commands

Several completion functions contain the following pattern to run git
commands respecting the path to the repository specified on the
command line:

git --git-dir="$(__gitdir)" <cmd> <options>

This imposes the overhead of fork()ing a subshell for the command
substitution and potentially fork()+exec()ing 'git rev-parse' inside
__gitdir().

Now, if neither '--gitdir=<path>' nor '-C <path>' options are
specified on the command line, then those git commands are perfectly
capable to discover the repository on their own.  If either one or
both of those options are specified on the command line, then, again,
the git commands could discover the repository, if we pass them all of
those options from the command line.

This means we don't have to run __gitdir() at all for git commands and
can spare its fork()+exec() overhead.

Use Bash parameter expansions to check the $__git_dir variable and
$__git_C_args array and to assemble the appropriate '--git-dir=<path>'
and '-C <path>' options if either one or both are present on the
command line.  These parameter expansions are, however, rather long,
so instead of changing all git executions and make already long lines
even longer, encapsulate running git with '--git-dir=<path> -C <path>'
options into the new __git() wrapper function.  Furthermore, this
wrapper function will also enable us to silence error messages from
git commands uniformly in one place in a later commit.

There's one tricky case, though: in __git_refs() local refs are listed
with 'git for-each-ref', where "local" is not necessarily the
repository we are currently in, but it might mean a remote repository
in the filesystem (e.g. listing refs for 'git fetch /some/other/repo
<TAB>').  Use one-shot variable assignment to override $__git_dir with
the path of the repository where the refs should come from.  Although
one-shot variable assignments in front of shell functions are to be
avoided in our scripts in general, in the Bash completion script we
can do that safely.

Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index f2d939d358dff9820912e774b9f5c2eb17bd684b..ec5478a1641631de3d1ebc93a772876867ea4c93 100644 (file)
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -61,6 +61,14 @@ __gitdir ()
        fi
 }
 
        fi
 }
 

+# Runs git with all the options given as argument, respecting any
+# '--git-dir=<path>' and '-C <path>' options present on the command line
+__git ()
+{
+       git ${__git_C_args:+"${__git_C_args[@]}"} \
+               ${__git_dir:+--git-dir="$__git_dir"} "$@"
+}
+

 # The following function is based on code from:
 #
 #   bash_completion - programmable completion functions for bash 3.2+
 # The following function is based on code from:
 #
 #   bash_completion - programmable completion functions for bash 3.2+


@@ -287,13 +295,11 @@ __gitcomp_file ()
 # argument, and using the options specified in the second argument.
 __git_ls_files_helper ()
 {
 # argument, and using the options specified in the second argument.
 __git_ls_files_helper ()
 {

-       local dir="$(__gitdir)"
-

        if [ "$2" == "--committable" ]; then
        if [ "$2" == "--committable" ]; then

-               git ${__git_C_args:+"${__git_C_args[@]}"} --git-dir="$dir" -C "$1" diff-index --name-only --relative HEAD
+               __git -C "$1" diff-index --name-only --relative HEAD

        else
                # NOTE: $2 is not quoted in order to support multiple options
        else
                # NOTE: $2 is not quoted in order to support multiple options

-               git ${__git_C_args:+"${__git_C_args[@]}"} --git-dir="$dir" -C "$1" ls-files --exclude-standard $2
+               __git -C "$1" ls-files --exclude-standard $2

        fi 2>/dev/null
 }
 
        fi 2>/dev/null
 }
 


@@ -323,8 +329,7 @@ __git_heads ()
 {
        local dir="$(__gitdir)"
        if [ -d "$dir" ]; then
 {
        local dir="$(__gitdir)"
        if [ -d "$dir" ]; then

-               git --git-dir="$dir" for-each-ref --format='%(refname:short)' \
-                       refs/heads
+               __git for-each-ref --format='%(refname:short)' refs/heads

                return
        fi
 }
                return
        fi
 }


@@ -333,8 +338,7 @@ __git_tags ()
 {
        local dir="$(__gitdir)"
        if [ -d "$dir" ]; then
 {
        local dir="$(__gitdir)"
        if [ -d "$dir" ]; then

-               git --git-dir="$dir" for-each-ref --format='%(refname:short)' \
-                       refs/tags
+               __git for-each-ref --format='%(refname:short)' refs/tags

                return
        fi
 }
                return
        fi
 }


@@ -385,14 +389,14 @@ __git_refs ()
                        refs="refs/tags refs/heads refs/remotes"
                        ;;
                esac
                        refs="refs/tags refs/heads refs/remotes"
                        ;;
                esac

-               git --git-dir="$dir" for-each-ref --format="$pfx%($format)" \
+               __git_dir="$dir" __git for-each-ref --format="$pfx%($format)" \

                        $refs
                if [ -n "$track" ]; then
                        # employ the heuristic used by git checkout
                        # Try to find a remote branch that matches the completion word
                        # but only output if the branch name is unique
                        local ref entry
                        $refs
                if [ -n "$track" ]; then
                        # employ the heuristic used by git checkout
                        # Try to find a remote branch that matches the completion word
                        # but only output if the branch name is unique
                        local ref entry

-                       git --git-dir="$dir" for-each-ref --shell --format="ref=%(refname:short)" \
+                       __git for-each-ref --shell --format="ref=%(refname:short)" \

                                "refs/remotes/" | \
                        while read -r entry; do
                                eval "$entry"
                                "refs/remotes/" | \
                        while read -r entry; do
                                eval "$entry"


@@ -406,7 +410,7 @@ __git_refs ()
        fi
        case "$cur" in
        refs|refs/*)
        fi
        case "$cur" in
        refs|refs/*)

-               git --git-dir="$dir" ls-remote "$remote" "$cur*" 2>/dev/null | \
+               __git ls-remote "$remote" "$cur*" 2>/dev/null | \

                while read -r hash i; do
                        case "$i" in
                        *^{}) ;;
                while read -r hash i; do
                        case "$i" in
                        *^{}) ;;


@@ -417,10 +421,10 @@ __git_refs ()
        *)
                if [ "$list_refs_from" = remote ]; then
                        echo "HEAD"
        *)
                if [ "$list_refs_from" = remote ]; then
                        echo "HEAD"

-                       git --git-dir="$dir" for-each-ref --format="%(refname:short)" \
+                       __git for-each-ref --format="%(refname:short)" \

                                "refs/remotes/$remote/" 2>/dev/null | sed -e "s#^$remote/##"
                else
                                "refs/remotes/$remote/" 2>/dev/null | sed -e "s#^$remote/##"
                else

-                       git --git-dir="$dir" ls-remote "$remote" HEAD \
+                       __git ls-remote "$remote" HEAD \

                                "refs/tags/*" "refs/heads/*" "refs/remotes/*" 2>/dev/null |
                        while read -r hash i; do
                                case "$i" in
                                "refs/tags/*" "refs/heads/*" "refs/remotes/*" 2>/dev/null |
                        while read -r hash i; do
                                case "$i" in


@@ -447,7 +451,7 @@ __git_refs2 ()
 __git_refs_remotes ()
 {
        local i hash
 __git_refs_remotes ()
 {
        local i hash

-       git --git-dir="$(__gitdir)" ls-remote "$1" 'refs/heads/*' 2>/dev/null | \
+       __git ls-remote "$1" 'refs/heads/*' 2>/dev/null | \

        while read -r hash i; do
                echo "$i:refs/remotes/$1/${i#refs/heads/}"
        done
        while read -r hash i; do
                echo "$i:refs/remotes/$1/${i#refs/heads/}"
        done


@@ -457,7 +461,7 @@ __git_remotes ()
 {
        local d="$(__gitdir)"
        test -d "$d/remotes" && ls -1 "$d/remotes"
 {
        local d="$(__gitdir)"
        test -d "$d/remotes" && ls -1 "$d/remotes"

-       git --git-dir="$d" remote
+       __git remote

 }
 
 # Returns true if $1 matches the name of a configured remote, false otherwise.
 }
 
 # Returns true if $1 matches the name of a configured remote, false otherwise.


@@ -523,7 +527,7 @@ __git_complete_revlist_file ()
                *)   pfx="$ref:$pfx" ;;
                esac
 
                *)   pfx="$ref:$pfx" ;;
                esac
 

-               __gitcomp_nl "$(git ${__git_C_args:+"${__git_C_args[@]}"} --git-dir="$(__gitdir)" ls-tree "$ls" 2>/dev/null \
+               __gitcomp_nl "$(__git ls-tree "$ls" 2>/dev/null \

                                | sed '/^100... blob /{
                                           s,^.*        ,,
                                           s,$, ,
                                | sed '/^100... blob /{
                                           s,^.*        ,,
                                           s,$, ,


@@ -801,7 +805,7 @@ __git_compute_porcelain_commands ()
 __git_get_config_variables ()
 {
        local section="$1" i IFS=$'\n'
 __git_get_config_variables ()
 {
        local section="$1" i IFS=$'\n'

-       for i in $(git --git-dir="$(__gitdir)" config --name-only --get-regexp "^$section\..*" 2>/dev/null); do
+       for i in $(__git config --name-only --get-regexp "^$section\..*" 2>/dev/null); do

                echo "${i#$section.}"
        done
 }
                echo "${i#$section.}"
        done
 }


@@ -819,8 +823,7 @@ __git_aliases ()
 # __git_aliased_command requires 1 argument
 __git_aliased_command ()
 {
 # __git_aliased_command requires 1 argument
 __git_aliased_command ()
 {

-       local word cmdline=$(git --git-dir="$(__gitdir)" \
-               config --get "alias.$1" 2>/dev/null)
+       local word cmdline=$(__git config --get "alias.$1" 2>/dev/null)

        for word in $cmdline; do
                case "$word" in
                \!gitk|gitk)
        for word in $cmdline; do
                case "$word" in
                \!gitk|gitk)


@@ -896,7 +899,7 @@ __git_get_option_value ()
        done
 
        if [ -n "$config_key" ] && [ -z "$result" ]; then
        done
 
        if [ -n "$config_key" ] && [ -z "$result" ]; then

-               result="$(git --git-dir="$(__gitdir)" config "$config_key")"
+               result="$(__git config "$config_key")"

        fi
 
        echo "$result"
        fi
 
        echo "$result"


@@ -1237,7 +1240,7 @@ _git_commit ()
                return
        esac
 
                return
        esac
 

-       if git --git-dir="$(__gitdir)" rev-parse --verify --quiet HEAD >/dev/null; then
+       if __git rev-parse --verify --quiet HEAD >/dev/null; then

                __git_complete_index_file "--committable"
        else
                # This is the first commit
                __git_complete_index_file "--committable"
        else
                # This is the first commit


@@ -1839,7 +1842,7 @@ _git_send_email ()
        case "$prev" in
        --to|--cc|--bcc|--from)
                __gitcomp "
        case "$prev" in
        --to|--cc|--bcc|--from)
                __gitcomp "

-               $(git --git-dir="$(__gitdir)" send-email --dump-aliases 2>/dev/null)
+               $(__git send-email --dump-aliases 2>/dev/null)

                "
                return
                ;;
                "
                return
                ;;


@@ -1871,7 +1874,7 @@ _git_send_email ()
                ;;
        --to=*|--cc=*|--bcc=*|--from=*)
                __gitcomp "
                ;;
        --to=*|--cc=*|--bcc=*|--from=*)
                __gitcomp "

-               $(git --git-dir="$(__gitdir)" send-email --dump-aliases 2>/dev/null)
+               $(__git send-email --dump-aliases 2>/dev/null)

                " "" "${cur#--*=}"
                return
                ;;
                " "" "${cur#--*=}"
                return
                ;;


@@ -1966,7 +1969,7 @@ __git_config_get_set_variables ()
                c=$((--c))
        done
 
                c=$((--c))
        done
 

-       git --git-dir="$(__gitdir)" config $config_file --name-only --list 2>/dev/null
+       __git config $config_file --name-only --list 2>/dev/null

 }
 
 _git_config ()
 }
 
 _git_config ()


@@ -2001,9 +2004,8 @@ _git_config ()
        remote.*.push)
                local remote="${prev#remote.}"
                remote="${remote%.push}"
        remote.*.push)
                local remote="${prev#remote.}"
                remote="${remote%.push}"

-               __gitcomp_nl "$(git --git-dir="$(__gitdir)" \
-                       for-each-ref --format='%(refname):%(refname)' \
-                       refs/heads)"
+               __gitcomp_nl "$(__git for-each-ref
+                       --format='%(refname):%(refname)' refs/heads)"

                return
                ;;
        pull.twohead|pull.octopus)
                return
                ;;
        pull.twohead|pull.octopus)


@@ -2591,12 +2593,12 @@ _git_stash ()
                        if [ $cword -eq 3 ]; then
                                __gitcomp_nl "$(__git_refs)";
                        else
                        if [ $cword -eq 3 ]; then
                                __gitcomp_nl "$(__git_refs)";
                        else

-                               __gitcomp_nl "$(git --git-dir="$(__gitdir)" stash list \
+                               __gitcomp_nl "$(__git stash list \

                                                | sed -n -e 's/:.*//p')"
                        fi
                        ;;
                show,*|apply,*|drop,*|pop,*)
                                                | sed -n -e 's/:.*//p')"
                        fi
                        ;;
                show,*|apply,*|drop,*|pop,*)

-                       __gitcomp_nl "$(git --git-dir="$(__gitdir)" stash list \
+                       __gitcomp_nl "$(__git stash list \

                                        | sed -n -e 's/:.*//p')"
                        ;;
                *)
                                        | sed -n -e 's/:.*//p')"
                        ;;
                *)