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

[PATCH] clone: support atomic operation with --separate-git-dir

From
Jens Lehmann <jens.lehmann@web.de>
Date
Jan 5, 2013, 20:17 UTC
Message-ID
<50E88A40.9010904@web.de>
In-Reply-To
<50E83DAE.1080500@web.de>

Since b57fb80a7d (init, clone: support --separate-git-dir for .git file) git clone supports the --separate-git-dir option to create the git dir outside the work tree. But when that option is used, the git dir won't be deleted in case the clone fails like it would be without this option. This makes clone lose its atomicity as in case of a failure a partly set up git dir is left behind. A real world example where this leads to problems is when "git submodule update" fails to clone a submodule and later calls to "git submodule update" stumble over the partially set up git dir and try to revive the submodule from there, which then fails with a not very user friendly error message.

Fix that by updating the junk_git_dir variable (used to remember if and what git dir should be removed in case of failure) to the new value given with the --seperate-git-dir option. Also add a test for this to t5600 (and while at it fix the former last test to not cd into a directory to test for its existence but use "test -d" instead).

Reported-by: Manlio Perillo <manlio.perillo@gmail.com>
Signed-off-by: Jens Lehmann <Jens.Lehmann@web.de>
---
Am 05.01.2013 15:50, schrieb Jens Lehmann:
Show 15 quoted lines
> Am 05.01.2013 15:01, schrieb Jens Lehmann:
>> The reason seems to be that clone leaves a partial initialized .git
>> directory in case of connection problems. The next time submodule
>> update runs it tries to revive the submodule from .git/modules/<name>
>> but fails as there are no objects in it.
>>
>> This looks like a bug in clone to me, as it takes precautions to clean
>> up if something goes wrong but doesn't do that in this case. But while
>> glancing over the code I didn't find out what goes wrong here.
> 
> I dug a bit deeper here and found the reason: In remove_junk() of
> builtin/clone.c the junk_git_dir points to the gitfile in the
> submodules work tree, not the .git/modules/<name> directory where
> clone was told to put the git directory. Will see if I can come up
> with a patch soonish ...

And this fixes it for me. Manlio, it'd be great if you could test this patch (but please not only remove .git/modules/<name> but also the submodule work tree before doing that).

 builtin/clone.c               |  4 +++-
 t/t5600-clone-fail-cleanup.sh | 12 +++++++++++-
 2 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/builtin/clone.c b/builtin/clone.c
index ec2f75b..8d23a62 100644
--- a/builtin/clone.c
+++ b/builtin/clone.c
@@ -771,8 +771,10 @@ int cmd_clone(int argc, const char **argv, const char *prefix)
 		die(_("could not create leading directories of '%s'"), git_dir);

 	set_git_dir_init(git_dir, real_git_dir, 0);
-	if (real_git_dir)
+	if (real_git_dir) {
 		git_dir = real_git_dir;
+		junk_git_dir = real_git_dir;
+	}

 	if (0 <= option_verbosity) {
 		if (option_bare)
diff --git a/t/t5600-clone-fail-cleanup.sh b/t/t5600-clone-fail-cleanup.sh
index ee06d28..4435693 100755
--- a/t/t5600-clone-fail-cleanup.sh
+++ b/t/t5600-clone-fail-cleanup.sh
@@ -37,6 +37,16 @@ test_expect_success \

 test_expect_success \
     'successful clone must leave the directory' \
-    'cd bar'
+    'test -d bar'
+
+test_expect_success 'failed clone --separate-git-dir should not leave any directories' '
+	mkdir foo/.git/objects.bak/ &&
+	mv foo/.git/objects/* foo/.git/objects.bak/ &&
+	test_must_fail git clone --separate-git-dir gitdir foo worktree &&
+	test_must_fail test -e gitdir &&
+	test_must_fail test -e worktree &&
+	mv foo/.git/objects.bak/* foo/.git/objects/ &&
+	rmdir foo/.git/objects.bak
+'

 test_done
-- 
1.8.1.81.gb1e9864
Previous: Jens LehmannNext: Manlio Perillo
Message 8 of 24 in “[BUG] git submodule update is not fail safe”
  1. Manlio PerilloJan 4, 2013
  2. Junio C HamanoJan 4, 2013
  3. Manlio PerilloJan 5, 2013
  4. Jens LehmannJan 5, 2013
  5. Jens LehmannJan 5, 2013
  6. Manlio PerilloJan 5, 2013
  7. Jens LehmannJan 5, 2013
  8. clone: support atomic operation with --separate-git-dirJens Lehmann, Jan 5, 2013
  9. Manlio PerilloJan 5, 2013
  10. Junio C HamanoJan 6, 2013
  11. Duy NguyenJan 6, 2013
  12. Jonathan NiederJan 6, 2013
  13. clone: forbid --bare --separate-git-dir <dir>Nguyễn Thái Ngọc Duy, Jan 6, 2013
  14. Jonathan NiederJan 6, 2013
  15. Junio C HamanoJan 6, 2013
  16. Duy NguyenJan 7, 2013
  17. Junio C HamanoJan 7, 2013
  18. Duy NguyenJan 8, 2013
  19. Jens LehmannJan 8, 2013
  20. Junio C HamanoJan 8, 2013
  21. Duy NguyenJan 8, 2013
  22. Junio C HamanoJan 8, 2013
  23. clone: forbid --bare --separate-git-dir <dir>Nguyễn Thái Ngọc Duy, Jan 11, 2013
  24. Junio C HamanoJan 11, 2013

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.