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

[PATCHv2 10/21] completion: list refs from remote when remote's name matches a directory

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

If the remote given to __git_refs() happens to match both the name of a configured remote and the name of a directory in the current working directory, then that directory is assumed to be a git repository, and listing refs from that directory will be attempted. This is wrong, because in such a situation git commands (e.g. 'git fetch|pull|push <remote>' whom these refs will eventually be passed to) give precedence to the configured remote. Therefore, __git_refs() should list refs from the configured remote as well.

Add the helper function __git_is_configured_remote() that checks whether its argument matches the name of a configured remote. Use this helper to decide how to handle the remote passed to __git_refs().

Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
---
 contrib/completion/git-completion.bash | 20 ++++++++++++++++++--
 t/t9902-completion.sh                  | 11 ++++++++++-
 2 files changed, 28 insertions(+), 3 deletions(-)
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index 7d7e8b9d9..fd0ba1f3b 100644
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -347,12 +347,16 @@ __git_refs ()
 	local format refs pfx
 
 	if [ -n "$remote" ]; then
-		if [ -d "$remote/.git" ]; then
+		if __git_is_configured_remote "$remote"; then
+			# configured remote takes precedence over a
+			# local directory with the same name
+			list_refs_from=remote
+		elif [ -d "$remote/.git" ]; then
 			dir="$remote/.git"
 		elif [ -d "$remote" ]; then
 			dir="$remote"
 		else
-			list_refs_from=remote
+			list_refs_from=url
 		fi
 	fi
 
@@ -435,6 +439,18 @@ __git_remotes ()
 	git --git-dir="$d" remote
 }
 
+# Returns true if $1 matches the name of a configured remote, false otherwise.
+__git_is_configured_remote ()
+{
+	local remote
+	for remote in $(__git_remotes); do
+		if [ "$remote" = "$1" ]; then
+			return 0
+		fi
+	done
+	return 1
+}
+
 __git_list_merge_strategies ()
 {
 	git merge -s help 2>&1 |
diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh
index 6e64cd6ba..a201b5212 100755
--- a/t/t9902-completion.sh
+++ b/t/t9902-completion.sh
@@ -373,6 +373,15 @@ test_expect_success '__git_remotes - list remotes from $GIT_DIR/remotes and from
 	test_cmp expect actual
 '
 
+test_expect_success '__git_is_configured_remote' '
+	test_when_finished "git remote remove remote_1" &&
+	git remote add remote_1 git://remote_1 &&
+	test_when_finished "git remote remove remote_2" &&
+	git remote add remote_2 git://remote_2 &&
+	verbose __git_is_configured_remote remote_2 &&
+	test_must_fail __git_is_configured_remote non-existent
+'
+
 test_expect_success 'setup for ref completion' '
 	git commit --allow-empty -m initial &&
 	git branch matching-branch &&
@@ -516,7 +525,7 @@ test_expect_success '__git_refs - configured remote - full refs - repo given on
 	test_cmp expected "$actual"
 '
 
-test_expect_failure '__git_refs - configured remote - remote name matches a directory' '
+test_expect_success '__git_refs - configured remote - remote name matches a directory' '
 	cat >expected <<-EOF &&
 	HEAD
 	branch-in-other
-- 
2.11.0.555.g967c1bcb3
Previous: SZEDER GáborNext: SZEDER Gábor
Message 14 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.