Disable auto-completion of remote branches in Git Bash?

Question

I'm working on a fairly large git repo with a couple of thousand (remote) branches. I am used to using auto-completion (using [TAB]) in the console (Git Bash in that case), so I unconsciously do that for git commands, too.

e.g. I'd type

git checkout task[TAB] 

with the effect that the console stalls for often minutes. Is there a way to limit auto-completion to local branches only?

Answer 1

With Git 2.13 (Q2 2017), you can disable (some of) the branch completion.

git checkout --no-guess ... # or: export GIT_COMPLETION_CHECKOUT_NO_GUESS=1 

See commit 60e71bb (21 Apr 2017) by Jeff King (peff).
^{(Merged by Junio C Hamano -- gitster -- in commit b439747, 01 May 2017)}

As documented in contrib/completion/git-completion.bash now:

You can set the following environment variables to influence the behavior of the completion routines:

GIT_COMPLETION_CHECKOUT_NO_GUESS 

When set to "1", do not include "DWIM" suggestions in git-checkout completion (e.g., completing "foo" when "origin/foo" exists).

Note: DWIM is short for Do What I Mean, where a system attempts to anticipate what users intend to do, correcting trivial errors automatically rather than blindly executing users' explicit but potentially incorrect inputs.

completion: optionally disable checkout DWIM

When we complete branch names for "git checkout", we also complete remote branch names that could trigger the DWIM behavior. Depending on your workflow and project, this can be either convenient or annoying.

For instance, my clone of gitster.git contains 74 local "jk/*" branches, but origin contains another 147.
When I want to checkout a local branch but can't quite remember the name, tab completion shows me 251 entries. And worse, for a topic that has been picked up for pu, the upstream branch name is likely to be similar to mine, leading to a high probability that I pick the wrong one and accidentally create a new branch.

---

Note: "picked up for pu": see a What's cooking in git.git: it starts with:

Commits prefixed with '-' are only in 'pu' (proposed updates) while commits prefixed with '+' are in 'next'.

This is part of the Git Workflow Graduation process.

pu (proposed updates) is an integration branch for things that are not quite ready for inclusion yet

---

This patch adds a way for the user to tell the completion code not to include DWIM suggestions for checkout.
This can already be done by typing:

git checkout --no-guess jk/<TAB> 

but that's rather cumbersome.

The downside, of course, is that you no longer get completion support when you do want to invoke the DWIM behavior.
But depending on your workflow, that may not be a big loss (for instance, in git.git I am much more likely to want to detach, so I'd type "git checkout origin/jk/<TAB>" anyway).

Answer 2

I'm assuming that you are using the git-completion.bash script, and that you only care about git checkout.

To accomplish this, I just changed one line in the definition of the _git_checkout () function in git-completion.bash:

<       __gitcomp_nl "$(__git_refs '' $track)" --- >       __gitcomp_nl "$(__git_heads '' $track)" 

My understanding is that this only affects the tab-completion action (because of its location within the * case of the switch-case statement).