completion: don't disambiguate tags and branches

szeder · gitster · commit 3ad8ea7ccc23 · 2017-03-23T11:18:22.000-07:00
When the completion script has to list only tags or only branches, it
uses the 'git for-each-ref' format 'refname:short', which makes sure
that all listed tags and branches are unambiguous.  However,
disambiguating tags and branches in these cases is wrong, because:

  - __git_tags(), the helper function listing possible tagname
    arguments for 'git tag', lists an ambiguous tag
    'refs/tags/ambiguous' as 'tags/ambiguous'.  Its only consumer,
    'git tag' expects its tagname argument to be under 'refs/tags/',
    thus it interprets that abgiguous tag as
    'refs/tags/tags/ambiguous'.  Clearly wrong.

  - __git_heads() lists possible branchname arguments for 'git branch'
    and possible 'branch.&lt;branchname&gt;' configuration subsections.
    Both of these expect branchnames to be under 'refs/heads/' and
    misinterpret a disambiguated branchname like 'heads/ambiguous'.

Furthermore, disambiguation involves several stat() syscalls for each
tag or branch, thus comes at a steep cost especially on Windows and/or
when there are a lot of tags or branches to be listed.

Use the 'git for-each-ref' format 'refname:strip=2' instead of
'refname:short' to avoid harmful disambiguation of tags and branches
in __git_tags() and __git_heads().

Signed-off-by: SZEDER Gábor &lt;szeder.dev@gmail.com&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
@@ -340,12 +340,12 @@ __git_index_files ()
 
 __git_heads ()
 {
-	__git for-each-ref --format='%(refname:short)' refs/heads
+	__git for-each-ref --format='%(refname:strip=2)' refs/heads
 }
 
 __git_tags ()
 {
-	__git for-each-ref --format='%(refname:short)' refs/tags
+	__git for-each-ref --format='%(refname:strip=2)' refs/tags
 }
 
 # Lists refs from the local (by default) or from a remote repository.

Original file line number	Diff line number	Diff line change
`@@ -340,12 +340,12 @@ __git_index_files ()`
`340`	`340`
`341`	`341`	`__git_heads ()`
`342`	`342`	`{`
`343`		`- __git for-each-ref --format='%(refname:short)' refs/heads`
	`343`	`+ __git for-each-ref --format='%(refname:strip=2)' refs/heads`
`344`	`344`	`}`
`345`	`345`
`346`	`346`	`__git_tags ()`
`347`	`347`	`{`
`348`		`- __git for-each-ref --format='%(refname:short)' refs/tags`
	`348`	`+ __git for-each-ref --format='%(refname:strip=2)' refs/tags`
`349`	`349`	`}`
`350`	`350`
`351`	`351`	`# Lists refs from the local (by default) or from a remote repository.`