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

[PATCH 7/8] worktree: generalize candidate worktree path validation

From
Eric Sunshine <sunshine@sunshineco.com>
Date
Jun 8, 2020, 06:23 UTC
Message-ID
<20200608062356.40264-8-sunshine@sunshineco.com>
In-Reply-To
<20200608062356.40264-1-sunshine@sunshineco.com>

"git worktree add" checks that the specified path is a valid location for a new worktree by ensuring that the path does not already exist and is not already registered to another worktree (a path can be registered but missing, for instance, if it resides on removable media). Since "git worktree add" is not the only command which should perform such validation ("git worktree move" ought to also), generalize the the validation function for use by other callers, as well.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---
 builtin/worktree.c | 29 ++++++++++++++++-------------
 1 file changed, 16 insertions(+), 13 deletions(-)
diff --git a/builtin/worktree.c b/builtin/worktree.c
index eebd77c46d..7c0637234e 100644
--- a/builtin/worktree.c
+++ b/builtin/worktree.c
@@ -274,34 +274,33 @@ static const char *worktree_basename(const char *path, int *olen)
 	return name;
 }
 
-static void validate_worktree_add(const char *path, const struct add_opts *opts)
+/* check that path is viable location for worktree */
+static void check_candidate_path(const char *path,
+				 int force,
+				 struct worktree **worktrees,
+				 const char *cmd)
 {
-	struct worktree **worktrees;
 	struct worktree *wt;
 	int locked;
 
 	if (file_exists(path) && !is_empty_dir(path))
 		die(_("'%s' already exists"), path);
 
-	worktrees = get_worktrees(0);
 	wt = find_worktree_by_path(worktrees, path);
 	if (!wt)
-		goto done;
+		return;
 
 	locked = !!worktree_lock_reason(wt);
-	if ((!locked && opts->force) || (locked && opts->force > 1)) {
+	if ((!locked && force) || (locked && force > 1)) {
 		if (delete_git_dir(wt->id))
-		    die(_("unable to re-add worktree '%s'"), path);
-		goto done;
+		    die(_("unusable worktree destination '%s'"), path);
+		return;
 	}
 
 	if (locked)
-		die(_("'%s' is a missing but locked worktree;\nuse 'add -f -f' to override, or 'unlock' and 'prune' or 'remove' to clear"), path);
+		die(_("'%s' is a missing but locked worktree;\nuse '%s -f -f' to override, or 'unlock' and 'prune' or 'remove' to clear"), cmd, path);
 	else
-		die(_("'%s' is a missing but already registered worktree;\nuse 'add -f' to override, or 'prune' or 'remove' to clear"), path);
-
-done:
-	free_worktrees(worktrees);
+		die(_("'%s' is a missing but already registered worktree;\nuse '%s -f' to override, or 'prune' or 'remove' to clear"), cmd, path);
 }
 
 static int add_worktree(const char *path, const char *refname,
@@ -318,8 +317,12 @@ static int add_worktree(const char *path, const char *refname,
 	struct commit *commit = NULL;
 	int is_branch = 0;
 	struct strbuf sb_name = STRBUF_INIT;
+	struct worktree **worktrees;
 
-	validate_worktree_add(path, opts);
+	worktrees = get_worktrees(0);
+	check_candidate_path(path, opts->force, worktrees, "add");
+	free_worktrees(worktrees);
+	worktrees = NULL;
 
 	/* is 'refname' a branch or commit? */
 	if (!opts->detach && !strbuf_check_branch_ref(&symref, refname) &&
-- 
2.27.0.290.gba653c62da
Previous: Eric SunshineNext: Junio C Hamano
Message 15 of 20 in “worktree: tighten duplicate path detection”
  1. 0/8 worktree: tighten duplicate path detectionEric Sunshine, Jun 8, 2020
  2. 1/8 worktree: factor out repeated string literalEric Sunshine, Jun 8, 2020
  3. Shourya ShuklaJun 8, 2020
  4. Eric SunshineJun 8, 2020
  5. 3/8 worktree: give "should be pruned?" function more meaningful nameEric Sunshine, Jun 8, 2020
  6. Junio C HamanoJun 8, 2020
  7. 2/8 worktree: prune corrupted worktree even if lockedEric Sunshine, Jun 8, 2020
  8. Junio C HamanoJun 8, 2020
  9. Eric SunshineJun 9, 2020
  10. 4/8 worktree: make high-level pruning re-usableEric Sunshine, Jun 8, 2020
  11. Junio C HamanoJun 8, 2020
  12. 6/8 worktree: prune linked worktree referencing main worktree pathEric Sunshine, Jun 8, 2020
  13. Junio C HamanoJun 8, 2020
  14. Eric SunshineJun 9, 2020
  15. 7/8 worktree: generalize candidate worktree path validationEric Sunshine, Jun 8, 2020
  16. Junio C HamanoJun 8, 2020
  17. 8/8 worktree: make "move" refuse to move atop missing registered worktreeEric Sunshine, Jun 8, 2020
  18. Eric SunshineJun 8, 2020
  19. Junio C HamanoJun 8, 2020
  20. 5/8 worktree: prune duplicate entries referencing same worktree pathEric Sunshine, Jun 8, 2020

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.