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

BUG: git worktree add directory-path fails due to over-aggressive disallowing of worktrees with same suffix

From
CGCameron Gunnin <cameron.gunnin@synopsys.com>
Date
Feb 11, 2019, 23:50 UTC
Message-ID
<0308570E-AAA3-43B8-A592-F4DA9760DBED@synopsys.com>
The bug:
  git init worktree-test-repo
  git --git-dir=worktree-test-repo/.git commit --allow-empty -m "first commit"
  git --git-dir=worktree-test-repo/.git branch branch1
  git --git-dir=worktree-test-repo/.git branch branch2
  mkdir unique-path-1 unique-path-2
  cd unique-path-1
  git --git-dir=../worktree-test-repo/.git worktree add subdir branch1
  cd ../unique-path-2
  git --git-dir=../worktree-test-repo/.git worktree add subdir branch2
  # FAILS WITH: fatal: 'subdir' is a missing but already registered worktree; use 'add -f' to override, or 'prune' or 'remove' to clear
Note: the following will succeed, implying that it is the suffix matching that is going awry:
  cd ..
  git --git-dir=worktree-test-repo/.git worktree add unique-path-2/subdir branch2
This appears to have been introduced by the following commit:
  commit cb56f55c16c128e18449c9417dc045f787c1b663
  Author: Eric Sunshine <sunshine@sunshineco.com>
  Date:   Tue Aug 28 17:20:22 2018 -0400
      worktree: disallow adding same path multiple times
The intention of the above commit was to avoid a bad case where a worktree at a given path was removed manually then re-created via 'git worktree add', leading to two entries in 'git worktree list' for the same directory. However, the bug shown here is a valid use case, as we're technically using two different paths.
The fix, I think, should be applied to builtin/worktree.c to the validate_worktree_add method. After finding a worktree that matches the suffix (via find_worktree), it should check that the absolute path of the found worktree is the same as the absolute path of the worktree being added, and allow the add when they are different. Or, perhaps there should be a way to invoke 'find_worktree' such that it only finds absolute path matches.
Thank you for your time,
- Cameron Gunnin
Next: Eric Sunshine
Message 1 of 8 in “BUG: git worktree add directory-path fails due to over-aggressive disallowing of worktrees with same suffix”
  1. Cameron GunninFeb 11, 2019
  2. Eric SunshineFeb 12, 2019
  3. 0/3 git-worktree: fix "add" being fooled by suffix matchingEric Sunshine, Feb 24, 2020
  4. 2/3 worktree: add utility to find worktree by pathnameEric Sunshine, Feb 24, 2020
  5. 3/3 worktree: don't allow "add" validation to be fooled by suffix matchingEric Sunshine, Feb 24, 2020
  6. Junio C HamanoFeb 24, 2020
  7. 1/3 worktree: improve find_worktree() documentationEric Sunshine, Feb 24, 2020
  8. Junio C HamanoFeb 24, 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.