git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCHv2 14/21] completion: fix completion after 'git -C <path>'

From
SZEDER Gábor <szeder.dev@gmail.com>
Date
Feb 3, 2017, 02:48 UTC
Message-ID
<20170203024829.8071-15-szeder.dev@gmail.com>
In-Reply-To
<20170203024829.8071-1-szeder.dev@gmail.com>

The main completion function finds the name of the git command by iterating through all the words on the command line in search for the first non-option-looking word. As it is not aware of 'git -C's mandatory path argument, if the '-C <path>' option is present, 'path' will be the first such word and it will be mistaken for a git command. This breaks completion in various ways:

 - If 'path' happens to match one of the commands supported by the
   completion script, then options of that command will be offered.
 - If 'path' doesn't match a supported command and doesn't contain any
   characters not allowed in Bash identifier names, then the
   completion script does basically nothing and Bash in turn falls
   back to filename completion for all subsequent words.
 - Otherwise, if 'path' does contain such an unallowed character, then
   it leads to a more or less ugly error message in the middle of the
   command line.  The standard '/' directory separator is such a
   character, and it happens to trigger one of the uglier errors:
     $ git -C some/path <TAB>sh.exe": declare: `_git_some/path': not a valid identifier
     error: invalid key: alias.some/path

Fix this by skipping 'git -C's mandatory path argument while iterating over the words on the command line. Extend the relevant test with this case and, while at it, with cases that needed similar treatment in the past ('--git-dir', '-c', '--work-tree' and '--namespace').

Additionally, silence the standard error of the 'declare' builtins looking for the completion function associated with the git command and of the 'git config' query for the aliased command. So if git ever learns a new option with a mandatory argument in the future, then, though the completion script will again misbehave, at least the command line will not be utterly disrupted by those error messages.

Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
---
 contrib/completion/git-completion.bash | 8 ++++----
 t/t9902-completion.sh                  | 7 ++++++-
 2 files changed, 10 insertions(+), 5 deletions(-)
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index 7d25b33b8..ac5eb9ced 100644
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -816,7 +816,7 @@ __git_aliases ()
 __git_aliased_command ()
 {
 	local word cmdline=$(git --git-dir="$(__gitdir)" \
-		config --get "alias.$1")
+		config --get "alias.$1" 2>/dev/null)
 	for word in $cmdline; do
 		case "$word" in
 		\!gitk|gitk)
@@ -2800,7 +2800,7 @@ __git_main ()
 		--git-dir)   ((c++)) ; __git_dir="${words[c]}" ;;
 		--bare)      __git_dir="." ;;
 		--help) command="help"; break ;;
-		-c|--work-tree|--namespace) ((c++)) ;;
+		-c|-C|--work-tree|--namespace) ((c++)) ;;
 		-*) ;;
 		*) command="$i"; break ;;
 		esac
@@ -2844,13 +2844,13 @@ __git_main ()
 	fi
 
 	local completion_func="_git_${command//-/_}"
-	declare -f $completion_func >/dev/null && $completion_func && return
+	declare -f $completion_func >/dev/null 2>/dev/null && $completion_func && return
 
 	local expansion=$(__git_aliased_command "$command")
 	if [ -n "$expansion" ]; then
 		words[1]=$expansion
 		completion_func="_git_${expansion//-/_}"
-		declare -f $completion_func >/dev/null && $completion_func
+		declare -f $completion_func >/dev/null 2>/dev/null && $completion_func
 	fi
 }
 
diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh
index 500505dca..be2ed8704 100755
--- a/t/t9902-completion.sh
+++ b/t/t9902-completion.sh
@@ -755,7 +755,12 @@ test_expect_success 'general options plus command' '
 	test_completion "git --namespace=foo check" "checkout " &&
 	test_completion "git --paginate check" "checkout " &&
 	test_completion "git --info-path check" "checkout " &&
-	test_completion "git --no-replace-objects check" "checkout "
+	test_completion "git --no-replace-objects check" "checkout " &&
+	test_completion "git --git-dir some/path check" "checkout " &&
+	test_completion "git -c conf.var=value check" "checkout " &&
+	test_completion "git -C some/path check" "checkout " &&
+	test_completion "git --work-tree some/path check" "checkout " &&
+	test_completion "git --namespace name/space check" "checkout "
 '
 
 test_expect_success 'git --help completion' '

-- 
2.11.0.555.g967c1bcb3
Previous: SZEDER GáborNext: SZEDER Gábor
Message 25 of 28 in “[PATCHv2 00/21] completion: various __gitdir()-related improvements”
  1. SZEDER GáborFeb 3, 2017
  2. 02/21 completion tests: don't add test cruft to the test repositorySZEDER Gábor, Feb 3, 2017
  3. 04/21 completion tests: consolidate getting path of current working directorySZEDER Gábor, Feb 3, 2017
  4. 05/21 completion tests: check __gitdir()'s output in the error casesSZEDER Gábor, Feb 3, 2017
  5. 03/21 completion tests: make the $cur variable local to the test helper functionsSZEDER Gábor, Feb 3, 2017
  6. 11/21 completion: don't list 'HEAD' when trying refs completion outside of a repoSZEDER Gábor, Feb 3, 2017
  7. 12/21 completion: list short refs from a remote given as a URLSZEDER Gábor, Feb 3, 2017
  8. 07/21 completion: ensure that the repository path given on the command line existsSZEDER Gábor, Feb 3, 2017
  9. 16/21 completion: respect 'git -C <path>'SZEDER Gábor, Feb 3, 2017
  10. 08/21 completion: fix most spots not respecting 'git --git-dir=<path>'SZEDER Gábor, Feb 3, 2017
  11. 15/21 rev-parse: add '--absolute-git-dir' optionSZEDER Gábor, Feb 3, 2017
  12. 18/21 completion: consolidate silencing errors from git commandsSZEDER Gábor, Feb 3, 2017
  13. 19/21 completion: don't guard git executions with __gitdir()SZEDER Gábor, Feb 3, 2017
  14. 10/21 completion: list refs from remote when remote's name matches a directorySZEDER Gábor, Feb 3, 2017
  15. 17/21 completion: don't use __gitdir() for git commandsSZEDER Gábor, Feb 3, 2017
  16. completion: restore removed line continuating backslashSZEDER Gábor, Feb 13, 2017
  17. Junio C HamanoFeb 13, 2017
  18. SZEDER GáborFeb 15, 2017
  19. Junio C HamanoFeb 15, 2017
  20. SZEDER GáborFeb 15, 2017
  21. 13/21 completion: don't offer commands when 'git --opt' needs an argumentSZEDER Gábor, Feb 3, 2017
  22. 20/21 completion: extract repository discovery from __gitdir()SZEDER Gábor, Feb 3, 2017
  23. 21/21 completion: cache the path to the repositorySZEDER Gábor, Feb 3, 2017
  24. 09/21 completion: respect 'git --git-dir=<path>' when listing remote refsSZEDER Gábor, Feb 3, 2017
  25. 14/21 completion: fix completion after 'git -C <path>'SZEDER Gábor, Feb 3, 2017
  26. 06/21 completion tests: add tests for the __git_refs() helper functionSZEDER Gábor, Feb 3, 2017
  27. 01/21 completion: improve __git_refs()'s in-code documentationSZEDER Gábor, Feb 3, 2017
  28. Junio C HamanoFeb 6, 2017

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.