checkout -b <name>: correctly detect existing branch

gitster · gitster · commit c17b229454ac · 2011-06-05T22:17:04.000-07:00
When create a new branch, we fed "refs/heads/&lt;proposed name&gt;" as a string
to get_sha1() and expected it to fail when a branch already exists.

The right way to check if a ref exists is to check with resolve_ref().

A naïve solution that might appear attractive but does not work is to
forbid slashes in get_describe_name() but that will not work. A describe
name is is in the form of "ANYTHING-g&lt;short sha1&gt;", and that ANYTHING part
comes from a original tag name used in the repository the user ran the
describe command. A sick user could have a confusing hierarchical tag
whose name is "refs/heads/foobar" (stored as refs/tags/refs/heads/foobar")
to generate a describe name "refs/heads/foobar-6-g02ac983", and we should
be able to use that name to refer to the object whose name is 02ac983.

Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/builtin/checkout.c b/builtin/checkout.c
@@ -874,7 +874,7 @@ int cmd_checkout(int argc, const char **argv, const char *prefix)
 		if (strbuf_check_branch_ref(&buf, opts.new_branch))
 			die("git checkout: we do not like '%s' as a branch name.",
 			    opts.new_branch);
-		if (!get_sha1(buf.buf, rev)) {
+		if (ref_exists(buf.buf)) {
 			opts.branch_exists = 1;
 			if (!opts.new_branch_force)
 				die("git checkout: branch %s already exists",
diff --git a/refs.c b/refs.c
@@ -1732,6 +1732,12 @@ int update_ref(const char *action, const char *refname,
 	return 0;
 }
 
+int ref_exists(char *refname)
+{
+	unsigned char sha1[20];
+	return !!resolve_ref(refname, sha1, 1, NULL);
+}
+
 struct ref *find_ref_by_name(const struct ref *list, const char *name)
 {
 	for ( ; list; list = list->next)
diff --git a/refs.h b/refs.h
@@ -46,6 +46,7 @@ extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refn
  */
 extern void add_extra_ref(const char *refname, const unsigned char *sha1, int flags);
 extern void clear_extra_refs(void);
+extern int ref_exists(char *);
 
 extern int peel_ref(const char *, unsigned char *);
 
diff --git a/t/t2018-checkout-branch.sh b/t/t2018-checkout-branch.sh
@@ -163,4 +163,15 @@ test_expect_success 'checkout -f -B to an existing branch with mergeable changes
 	test_must_fail test_dirty_mergeable
 '
 
+test_expect_success 'checkout -b <describe>' '
+	git tag -f -m "First commit" initial initial &&
+	git checkout -f change1 &&
+	name=$(git describe) &&
+	git checkout -b $name &&
+	git diff --exit-code change1 &&
+	echo "refs/heads/$name" >expect &&
+	git symbolic-ref HEAD >actual &&
+	test_cmp expect actual
+'
+
 test_done

Original file line number	Diff line number	Diff line change
`@@ -1732,6 +1732,12 @@ int update_ref(const char action, const char refname,`
`1732`	`1732`	`return 0;`
`1733`	`1733`	`}`
`1734`	`1734`
	`1735`	`+int ref_exists(char *refname)`
	`1736`	`+{`
	`1737`	`+ unsigned char sha1[20];`
	`1738`	`+ return !!resolve_ref(refname, sha1, 1, NULL);`
	`1739`	`+}`
	`1740`	`+`
`1735`	`1741`	`struct ref find_ref_by_name(const struct ref list, const char *name)`
`1736`	`1742`	`{`
`1737`	`1743`	`for ( ; list; list = list->next)`