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

[PATCH v2 7/8] strbuf_check_ref_format(): expand only local branches

From
Jeff King <peff@peff.net>
Date
Mar 2, 2017, 08:23 UTC
Message-ID
<20170302082313.uzh7vburrk6tqcuo@sigill.intra.peff.net>
In-Reply-To
<20170302082100.edaretznmlralswa@sigill.intra.peff.net>

This function asks strbuf_branchname() to expand any @-marks in the branchname, and then we blindly stick refs/heads/ in front of the result. This is obviously nonsense if the expansion is "HEAD" or a ref in refs/remotes/.

The most obvious end-user effect is that creating or renaming a branch with an expansion may have confusing results (e.g., creating refs/heads/origin/master from "@{upstream}" when the operation should be disallowed).

We can fix this by telling strbuf_branchname() that we are only interested in local expansions. Any unexpanded bits are then fed to check_ref_format(), which either disallows them (in the case of "@{upstream}") or lets them through ("refs/heads/@" is technically valid, if a bit silly).

Signed-off-by: Jeff King <peff@peff.net>
---
 sha1_name.c                           | 2 +-
 t/t3204-branch-name-interpretation.sh | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/sha1_name.c b/sha1_name.c
index 7f754b60c..26ceec1d7 100644
--- a/sha1_name.c
+++ b/sha1_name.c
@@ -1319,7 +1319,7 @@ void strbuf_branchname(struct strbuf *sb, const char *name, unsigned allowed)
 
 int strbuf_check_branch_ref(struct strbuf *sb, const char *name)
 {
-	strbuf_branchname(sb, name, 0);
+	strbuf_branchname(sb, name, INTERPRET_BRANCH_LOCAL);
 	if (name[0] == '-')
 		return -1;
 	strbuf_splice(sb, 0, 0, "refs/heads/", 11);
diff --git a/t/t3204-branch-name-interpretation.sh b/t/t3204-branch-name-interpretation.sh
index 4f4af1fb4..05e88f92d 100755
--- a/t/t3204-branch-name-interpretation.sh
+++ b/t/t3204-branch-name-interpretation.sh
@@ -42,7 +42,7 @@ test_expect_success 'update branch via local @{upstream}' '
 	expect_branch local two
 '
 
-test_expect_failure 'disallow updating branch via remote @{upstream}' '
+test_expect_success 'disallow updating branch via remote @{upstream}' '
 	git update-ref refs/remotes/origin/remote one &&
 	git branch --set-upstream-to=origin/remote &&
 
@@ -109,7 +109,7 @@ test_expect_success 'disallow deleting remote branch via @{-1}' '
 # and not refs/heads/HEAD. These tests should not imply that refs/heads/@ is a
 # sane thing, but it _is_ technically allowed for now. If we disallow it, these
 # can be switched to test_must_fail.
-test_expect_failure 'create branch named "@"' '
+test_expect_success 'create branch named "@"' '
 	git branch -f @ one &&
 	expect_branch refs/heads/@ one
 '
-- 
2.12.0.367.gb23790f66
Previous: Jeff KingNext: Jacob Keller
Message 8 of 10 in “fixing corner-cases with interpret_branch_name()”
  1. fixing corner-cases with interpret_branch_name()Jeff King, Mar 2, 2017
  2. 1/8 interpret_branch_name: move docstring to header fileJeff King, Mar 2, 2017
  3. 3/8 strbuf_branchname: add docstringJeff King, Mar 2, 2017
  4. 2/8 strbuf_branchname: drop return valueJeff King, Mar 2, 2017
  5. 4/8 interpret_branch_name: allow callers to restrict expansionsJeff King, Mar 2, 2017
  6. 5/8 t3204: test git-branch @-expansion corner casesJeff King, Mar 2, 2017
  7. 6/8 branch: restrict @-expansions when deletingJeff King, Mar 2, 2017
  8. 7/8 strbuf_check_ref_format(): expand only local branchesJeff King, Mar 2, 2017
  9. Jacob KellerMar 2, 2017
  10. 8/8 checkout: restrict @-expansions when finding branchJeff King, Mar 2, 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.