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

[PATCH v2 16/20] worktree: detect branch-name/detached and error conditions locally

From
Eric Sunshine <sunshine@sunshineco.com>
Date
Jul 16, 2015, 08:20 UTC
Message-ID
<1437034825-32054-17-git-send-email-sunshine@sunshineco.com>
In-Reply-To
<1437034825-32054-1-git-send-email-sunshine@sunshineco.com>

git-worktree currently conflates setting of HEAD in the new worktree with initial worktree population via a single git-checkout invocation, which requires git-checkout to have special knowledge that it is operating in a newly created worktree. The eventual goal is to separate these operations and rid git-checkout of that overly-intimate knowledge.

Once these operations are separate, git-worktree will no longer be able to rely upon git-branch to determine the state of the worktree (branch name or detached), or to check for error conditions, such as the requested branch already checked out elsewhere, or an invalid reference. Therefore, imbue git-worktree with the intelligence to determine a branch name or detached state locally, and to perform error checking on its own.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---

Changes since v1: don't bother calling ref_exists() for newly created branch; add a few in-code comments explaining logic; reword commit message.

 builtin/worktree.c | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
diff --git a/builtin/worktree.c b/builtin/worktree.c
index 28095c1..e8f3f30 100644
--- a/builtin/worktree.c
+++ b/builtin/worktree.c
@@ -3,6 +3,8 @@
 #include "dir.h"
 #include "parse-options.h"
 #include "argv-array.h"
+#include "branch.h"
+#include "refs.h"
 #include "run-command.h"
 #include "sigchain.h"
 
@@ -188,11 +190,26 @@ static int add_worktree(const char *path, const char *refname,
 	struct child_process cp;
 	struct argv_array child_env = ARGV_ARRAY_INIT;
 	int counter = 0, len, ret;
+	struct strbuf symref = STRBUF_INIT;
+	struct commit *commit = NULL;
 	unsigned char rev[20];
 
 	if (file_exists(path) && !is_empty_dir(path))
 		die(_("'%s' already exists"), path);
 
+	/* is 'refname' a branch or commit? */
+	if (opts->force_new_branch) /* definitely a branch */
+		;
+	else if (!opts->detach && !strbuf_check_branch_ref(&symref, refname) &&
+		 ref_exists(symref.buf)) { /* it's a branch */
+		if (!opts->force)
+			die_if_checked_out(symref.buf);
+	} else { /* must be a commit */
+		commit = lookup_commit_reference_by_name(refname);
+		if (!commit)
+			die(_("invalid reference: %s"), refname);
+	}
+
 	name = worktree_basename(path, &len);
 	strbuf_addstr(&sb_repo,
 		      git_path("worktrees/%.*s", (int)(path + len - name), name));
@@ -281,6 +298,7 @@ static int add_worktree(const char *path, const char *refname,
 	unlink_or_warn(sb.buf);
 	argv_array_clear(&child_env);
 	strbuf_release(&sb);
+	strbuf_release(&symref);
 	strbuf_release(&sb_repo);
 	strbuf_release(&sb_git);
 	return ret;
-- 
2.5.0.rc2.378.g0af52e8
Previous: Eric SunshineNext: Eric Sunshine
Message 20 of 25 in “rid git-checkout of too-intimate knowledge of new worktree”
  1. 00/20 rid git-checkout of too-intimate knowledge of new worktreeEric Sunshine, Jul 16, 2015
  2. 01/20 checkout: avoid resolving HEAD unnecessarilyEric Sunshine, Jul 16, 2015
  3. 02/20 checkout: name check_linked_checkouts() more meaningfullyEric Sunshine, Jul 16, 2015
  4. 03/20 checkout: improve die_if_checked_out() robustnessEric Sunshine, Jul 16, 2015
  5. 04/20 checkout: die_if_checked_out: simplify strbuf managementEric Sunshine, Jul 16, 2015
  6. 05/20 checkout: generalize die_if_checked_out() branch name argumentEric Sunshine, Jul 16, 2015
  7. 06/20 checkout: check_linked_checkout: improve "already checked out" aestheticEric Sunshine, Jul 16, 2015
  8. Junio C HamanoJul 16, 2015
  9. Eric SunshineJul 17, 2015
  10. Duy NguyenJul 17, 2015
  11. 07/20 checkout: check_linked_checkout: simplify symref parsingEric Sunshine, Jul 16, 2015
  12. 08/20 checkout: teach check_linked_checkout() about symbolic link HEADEric Sunshine, Jul 16, 2015
  13. 09/20 branch: publish die_if_checked_out()Eric Sunshine, Jul 16, 2015
  14. 10/20 worktree: simplify new branch (-b/-B) option checkingEric Sunshine, Jul 16, 2015
  15. 11/20 worktree: introduce options containerEric Sunshine, Jul 16, 2015
  16. 12/20 worktree: make --detach mutually exclusive with -b/-BEric Sunshine, Jul 16, 2015
  17. 13/20 worktree: make branch creation distinct from worktree populationEric Sunshine, Jul 16, 2015
  18. 14/20 worktree: elucidate environment variables intended for child processesEric Sunshine, Jul 16, 2015
  19. 15/20 worktree: add_worktree: construct worktree-population command locallyEric Sunshine, Jul 16, 2015
  20. 16/20 worktree: detect branch-name/detached and error conditions locallyEric Sunshine, Jul 16, 2015
  21. 17/20 worktree: make setup of new HEAD distinct from worktree populationEric Sunshine, Jul 16, 2015
  22. 18/20 worktree: avoid resolving HEAD unnecessarilyEric Sunshine, Jul 16, 2015
  23. 19/20 worktree: populate via "git reset --hard" rather than "git checkout"Eric Sunshine, Jul 16, 2015
  24. 20/20 checkout: drop intimate knowledge of newly created worktreeEric Sunshine, Jul 16, 2015
  25. Junio C HamanoJul 16, 2015

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.