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

Re: [PATCH v3 1/1] git-gui: handle missing worktree and separated gitdir

From
Johannes Sixt <j6t@kdbg.org>
Date
May 1, 2026, 13:13 UTC
Message-ID
<77219c75-7968-413f-a642-0446145c8023@kdbg.org>
In-Reply-To
<3b0b37ed-1a5d-4fe1-b2b4-7db67a62a06d@gmail.com>
Am 30.04.26 um 18:18 schrieb Mark Levedahl:
Show 90 quoted lines
> 
> 
> On 4/30/26 6:02 AM, Shroom Moo wrote:
>> When git-gui is started from a directory that Git recognizes as a
>> valid repository but the working tree is not accessible (e.g., a
>> separated gitdir created by `git clone --separate-git-dir`, a bare
>> repository, or a case where the worktree directory was removed),
>> it previously called `rev-parse --show-toplevel` without error
>> handling, causing a fatal Tcl error ("this operation must be run
>> in a work tree").
>>
>> Wrap the call in a `catch` and handle the failure as follows:
>>
>> - For bare repositories, keep `_gitworktree` empty so that the
>>   existing `is_bare` check shows "Cannot use bare repository" and
>>   exits.  No behavioral change.
>>
>> - For non‑bare repositories, try to locate the worktree from the
>>   parent directory using `git -C $parent rev-parse --show-toplevel`.
>>   If the parent is a valid worktree, change to it; this covers the
>>   legitimate case of starting git-gui from within the .git
>>   subdirectory of a normal working tree.
>>
>> - If the parent directory is not a worktree, refuse to start with
>>   a clear error message.  This prevents dangerous operations in a
>>   separated gitdir, where ordinary Git commands like `git status`
>>   would themselves refuse to run.
>>
>> The approach intentionally avoids two pitfalls:
>>
>>   - Testing `--is-inside-git-dir` before calling `--show-toplevel`
>>     would break the normal use case of starting git-gui from within
>>     a .git subdirectory (where --show-toplevel would succeed).
>>
>>   - A simple “non‑bare” check after a failed --show-toplevel would
>>     reject a normal repository whose worktree was only temporarily
>>     removed.
>>
>> The chosen method keeps the original behavior for bare repositories
>> and for regular working trees, fixes the crash, and properly blocks
>> separated gitdirs without a reachable worktree.
>>
>> Signed-off-by: Shroom Moo <egg_mushroomcow@foxmail.com>
>> ---
>>  git-gui/git-gui.sh | 23 ++++++++++++++++++++++-
>>  1 file changed, 22 insertions(+), 1 deletion(-)
>>
>> diff --git a/git-gui/git-gui.sh b/git-gui/git-gui.sh
>> index 23fe76e498..2392282df3 100755
>> --- a/git-gui/git-gui.sh
>> +++ b/git-gui/git-gui.sh
>> @@ -1169,7 +1169,28 @@ if {![file isdirectory $_gitdir]} {
>>  load_config 0
>>  apply_config
>>  
>> -set _gitworktree [git rev-parse --show-toplevel]
>> +if {[catch {set _gitworktree [git rev-parse --show-toplevel]}]} {
>> +	# For bare repositories, use the existing error handling
>> +	if {![catch {set bare [git rev-parse --is-bare-repository]}] && $bare eq {true}} {
>> +		set _gitworktree {}
>> +	} else {
>> +		# Non-bare: try to find the worktree from the parent directory
>> +		set parent [file dirname [pwd]]
>> +		# Cannot go higher than the root directory; leave _gitworktree empty
>> +		if {[file normalize $parent] eq [file normalize [pwd]]} {
>> +			# Already at the filesystem root; let existing paths cope
>> +			set _gitworktree {}
>> +		} elseif {![catch {
>> +			set _gitworktree [git -C $parent rev-parse --show-toplevel]
>> +		}]} {
>> +			cd $parent
>> +		} else {
>> +			catch {wm withdraw .}
>> +			error_popup [mc "Cannot start git-gui from inside the Git directory."]
>> +			exit 1
>> +		}
>> +	}
>> +}
>>  
>>  if {$_prefix ne {}} {
>>  	if {$_gitworktree eq {}} {
> 
> A bare repository can be contained in a workdir / worktree pointing at a different gitdir:
> the logic above can thus a workdir that doesn't use the gitdir where git-gui was started.
> The bigger issue is that a gitdir can support multiple checked-out directories with no
> one-to-one mapping and no clear idea of which of those a user may have intended.
> 
> So, I believe the correct fix is to test "rev-parse --is-inside-git-dir, and if so throw a
> clear error message and exit. This will give the user something to start with to solve the
> problem of why they started git-gui in a gitdir, and not in a worktree.

We have quite a bit of code that attempts to make Git GUI work from the .git directory and also in bare repositories.

87cd09f43e56 ("git-gui: work from the .git dir", 2010-01-23) made the first step. The original code just used the $_gitdir as the working directory. However, at that time we did not have alternate worktrees, and the old code, when used today, does not work in a `git worktree`-created worktree. Later, the `git rev-parse --show-toplevel` call came with 38ec8d3e2652 ("git-gui: correct assignment of work-tree", 2010-10-20). However, it also changes the fall-back code slightly, so that running Git GUI from the .git directory would not work the same way as before and takes the .git directory as the work tree (because in the .git directory --show-cdup is not "..", but empty).

I think we need to restructure the existing flow a bit and not just fix a single spot in the code. I suggest this order of operation:

1. Handle the bare repository case. If not enabled, fail. Otherwise, we
can work with an empty $_gitworktree.
2. Collect --show-toplevel into $_gitworktree.

2a. If this failed: If --is-inside-git-dir is true, and the last $_gitdir directory component is exactly ".git", take the parent repository as $_gitworktree. Otherwise, fail.

3. Handle all the other edge cases, if any, with the so determined
$_gitworktree. (I didn't think through, yet, what needs to be done.)
-- Hannes
Previous: Shroom MooNext: Mark Levedahl
Message 8 of 134 in “git-gui: handle bare repo or missing worktree”
  1. git-gui: handle bare repo or missing worktreeShroom Moo, Apr 21, 2026
  2. Johannes SixtApr 29, 2026
  3. 1/1 git-gui: protect rev-parse --show-toplevel callShroom Moo, Apr 29, 2026
  4. Mark LevedahlApr 29, 2026
  5. 1/1 git-gui: handle missing worktree and separated gitdirShroom Moo, Apr 30, 2026
  6. Mark LevedahlApr 30, 2026
  7. Shroom MooMay 1, 2026
  8. Johannes SixtMay 1, 2026
  9. Mark LevedahlMay 1, 2026
  10. Mark LevedahlMay 2, 2026
  11. Johannes SixtMay 3, 2026
  12. Mark LevedahlMay 4, 2026
  13. Mark LevedahlMay 5, 2026
  14. Johannes SixtMay 6, 2026
  15. Mark LevedahlMay 6, 2026
  16. Johannes SixtMay 6, 2026
  17. Mark LevedahlMay 6, 2026
  18. Mark LevedahlMay 7, 2026
  19. 1/1 git-gui: handle missing worktree and separated gitdirShroom Moo, May 1, 2026
  20. 1/1 git-gui: restructure repository startupShroom Moo, May 4, 2026
  21. Johannes SixtMay 6, 2026
  22. 0/3 git-gui: robustify startup and fix environment handlingShroom Moo, May 6, 2026
  23. 0/3 git-gui: robustify startup and fix environment handlingShroom Moo, May 9, 2026
  24. Mark LevedahlMay 14, 2026
  25. 00/11 Improve git gui operation without a worktreeMark Levedahl, May 14, 2026
  26. 01/11 git-gui: allow specifying path '.' to the browserMark Levedahl, May 14, 2026
  27. Johannes SixtMay 15, 2026
  28. Mark LevedahlMay 16, 2026
  29. 02/11 git-gui: refactor browser / blame argument parsingMark Levedahl, May 14, 2026
  30. Johannes SixtMay 15, 2026
  31. Mark LevedahlMay 16, 2026
  32. 04/11 git-gui: put choose_repository::pick in a procMark Levedahl, May 14, 2026
  33. Aina BootMay 15, 2026
  34. Mark LevedahlMay 15, 2026
  35. Johannes SixtMay 15, 2026
  36. Mark LevedahlMay 16, 2026
  37. 05/11 git-gui: use --absolute-git-dirMark Levedahl, May 14, 2026
  38. Johannes SixtMay 15, 2026
  39. Mark LevedahlMay 16, 2026
  40. 03/11 git-gui: guard set/unset of GIT_DIR and GIT_WORK_TREEMark Levedahl, May 14, 2026
  41. Johannes SixtMay 15, 2026
  42. Mark LevedahlMay 16, 2026
  43. 06/11 git gui: GIT_DIR / GIT_WORK_TREE make any discovery error fatalMark Levedahl, May 14, 2026
  44. 07/11 git-gui: use rev-parse exclusively to find a repositoryMark Levedahl, May 14, 2026
  45. Johannes SixtMay 15, 2026
  46. Mark LevedahlMay 16, 2026
  47. 08/11 git-gui: simplify [is_bare] to report if a worktree is knownMark Levedahl, May 14, 2026
  48. Johannes SixtMay 16, 2026
  49. 09/11 git-gui: support using repository parent dir as a worktreeMark Levedahl, May 14, 2026
  50. Johannes SixtMay 16, 2026
  51. Mark LevedahlMay 16, 2026
  52. 10/11 git-gui: improve worktree discoveryMark Levedahl, May 14, 2026
  53. Johannes SixtMay 16, 2026
  54. Mark LevedahlMay 16, 2026
  55. Johannes SixtMay 19, 2026
  56. Mark LevedahlMay 19, 2026
  57. 11/11 git-gui: add gui and pick as explicit subcommandsMark Levedahl, May 14, 2026
  58. Johannes SixtMay 16, 2026
  59. Mark LevedahlMay 16, 2026
  60. Johannes SixtMay 19, 2026
  61. Mark LevedahlMay 19, 2026
  62. Johannes SixtMay 19, 2026
  63. Johannes SixtMay 16, 2026
  64. 00/11 Improve git gui operation without a worktreeMark Levedahl, May 20, 2026
  65. 01/11 git-gui: guard set/unset of GIT_DIR and GIT_WORK_TREEMark Levedahl, May 20, 2026
  66. Johannes SixtMay 22, 2026
  67. Mark LevedahlMay 22, 2026
  68. Johannes SixtMay 23, 2026
  69. Aina BootMay 23, 2026
  70. Mark LevedahlMay 23, 2026
  71. 02/11 git-gui: return status from choose_repository::pickMark Levedahl, May 20, 2026
  72. Johannes SixtMay 22, 2026
  73. 04/11 git-gui: use rev-parse exclusively to find a repositoryMark Levedahl, May 20, 2026
  74. Johannes SixtMay 22, 2026
  75. Mark LevedahlMay 22, 2026
  76. Mark LevedahlMay 22, 2026
  77. 05/11 git-gui: simplify [is_bare] to report if a worktree is knownMark Levedahl, May 20, 2026
  78. 06/11 git-gui: use git rev-parse for worktree discoveryMark Levedahl, May 20, 2026
  79. Johannes SixtMay 23, 2026
  80. 07/11 git-gui: try harder to find worktree from gitdirMark Levedahl, May 20, 2026
  81. Shroom MooMay 21, 2026
  82. Mark LevedahlMay 21, 2026
  83. Shroom MooMay 22, 2026
  84. Mark LevedahlMay 22, 2026
  85. Johannes SixtMay 23, 2026
  86. Shroom MooMay 23, 2026
  87. Johannes SixtMay 23, 2026
  88. Mark LevedahlMay 23, 2026
  89. 03/11 git-gui: use --absolute-git-dirMark Levedahl, May 20, 2026
  90. Johannes SixtMay 22, 2026
  91. 08/11 git-gui: use HEAD as current branch when detached (bug fix)Mark Levedahl, May 20, 2026
  92. Johannes SixtMay 23, 2026
  93. 09/11 git-gui: allow specifying path '.' to the browserMark Levedahl, May 20, 2026
  94. Johannes SixtMay 23, 2026
  95. Mark LevedahlMay 23, 2026
  96. 10/11 git-gui: adapt blame/browser parsing for bare operationMark Levedahl, May 20, 2026
  97. Shroom MooMay 21, 2026
  98. Mark LevedahlMay 21, 2026
  99. Shroom MooMay 22, 2026
  100. fixup git-gui: allow blame to show uncommitted changesMark Levedahl, May 23, 2026
  101. Johannes SixtMay 23, 2026
  102. 11/11 git-gui: add gui and pick as explicit subcommandsMark Levedahl, May 20, 2026
  103. Johannes SixtMay 24, 2026
  104. Johannes SixtMay 24, 2026
  105. Mark LevedahlMay 25, 2026
  106. 00/12 Improve git gui operation without a worktreeMark Levedahl, May 31, 2026
  107. 01/12 git-gui: use HEAD as current branch when detachedMark Levedahl, May 31, 2026
  108. 02/12 git-gui: remove unnecessary 'cd $_gitworktree' from do_gitkMark Levedahl, May 31, 2026
  109. 03/12 git-gui: guard set/unset of GIT_DIR and GIT_WORK_TREEMark Levedahl, May 31, 2026
  110. 04/12 git-gui: do not change global vars in choose_repository::pickMark Levedahl, May 31, 2026
  111. 05/12 git-gui: use --absolute-git-dirMark Levedahl, May 31, 2026
  112. 06/12 git-gui: use rev-parse exclusively to find a repositoryMark Levedahl, May 31, 2026
  113. 07/12 git-gui: use git rev-parse for worktree discoveryMark Levedahl, May 31, 2026
  114. 08/12 git-gui: simplify [is_bare] to report if a worktree is knownMark Levedahl, May 31, 2026
  115. 09/12 git-gui: try harder to find worktree from gitdirMark Levedahl, May 31, 2026
  116. 10/12 git-gui: allow specifying path '.' to the browserMark Levedahl, May 31, 2026
  117. 11/12 git-gui: check browser/blame arguments carefullyMark Levedahl, May 31, 2026
  118. 12/12 git-gui: add gui and pick as explicit subcommandsMark Levedahl, May 31, 2026
  119. Johannes SixtJun 2, 2026
  120. Mark LevedahlJun 2, 2026
  121. Johannes SixtJun 2, 2026
  122. Shroom MooApr 29, 2026
  123. 2/3 git-gui: disable gitk visualization when no worktree availableShroom Moo, May 6, 2026
  124. 1/3 git-gui: restructure repository startupShroom Moo, May 6, 2026
  125. 3/3 git-gui: handle GIT_DIR and GIT_WORK_TREE earlyShroom Moo, May 6, 2026
  126. Mark LevedahlMay 7, 2026
  127. Aina BootMay 9, 2026
  128. Shroom MooMay 9, 2026
  129. 1/3 git-gui: restructure repository startupShroom Moo, May 9, 2026
  130. Johannes SixtMay 15, 2026
  131. 3/3 git-gui: handle GIT_DIR and GIT_WORK_TREE earlyShroom Moo, May 9, 2026
  132. Johannes SixtMay 15, 2026
  133. 2/3 git-gui: disable gitk visualization when no worktree availableShroom Moo, May 9, 2026
  134. Johannes SixtMay 15, 2026

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.