submodule: unset core.worktree if no working tree is present

When a submodules work tree is removed, we should unset its core.worktree setting as the worktree is no longer present. This is not just in line with the conceptual view of submodules, but it fixes an inconvenience for looking at submodules that are not checked out: git clone --recurse-submodules git://github.com/git/git && cd git && git checkout --recurse-submodules v2.13.0 git -C .git/modules/sha1collisiondetection log fatal: cannot chdir to '../../../sha1collisiondetection': \ No such file or directory With this patch applied, the final call to git log works instead of dying in its setup, as the checkout will unset the core.worktree setting such that following log will be run in a bare repository. This patch covers all commands that are in the unpack machinery, i.e. checkout, read-tree, reset. A follow up patch will address "git submodule deinit", which will also make use of the new function submodule_unset_core_worktree(), which is why we expose it in this patch. Signed-off-by: Stefan Beller <sbeller@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Stefan Beller committed Jun 12, 2018 at 16:58 UTC 4fa4f90ccd85842e1187e5a5daf4633dceaab779
3 files changed +18 -1
submodule.c
+14
@@ -1532,6 +1532,18 @@ out:
1532 return ret;
1533 }
1534
1535 +void submodule_unset_core_worktree(const struct submodule *sub)
1536 +{
1537 + char *config_path = xstrfmt("%s/modules/%s/config",
1538 + get_git_common_dir(), sub->name);
1539 +
1540 + if (git_config_set_in_file_gently(config_path, "core.worktree", NULL))
1541 + warning(_("Could not unset core.worktree setting in submodule '%s'"),
1542 + sub->path);
1543 +
1544 + free(config_path);
1545 +}
1546 +
1547 static const char *get_super_prefix_or_empty(void)
1548 {
1549 const char *s = get_super_prefix();
@@ -1697,6 +1709,8 @@ int submodule_move_head(const char *path,
1709
1710 if (is_empty_dir(path))
1711 rmdir_or_warn(path);
1712 +
1713 + submodule_unset_core_worktree(sub);
1714 }
1715 }
1716 out:
submodule.h
+2
@@ -121,6 +121,8 @@ extern int submodule_move_head(const char *path,
121 const char *new_head,
122 unsigned flags);
123
124 +void submodule_unset_core_worktree(const struct submodule *sub);
125 +
126 /*
127 * Prepare the "env_array" parameter of a "struct child_process" for executing
128 * a submodule by clearing any repo-specific environment variables, but
t/lib-submodule-update.sh
+2 -1
@@ -709,7 +709,8 @@ test_submodule_recursing_with_args_common() {
709 git branch -t remove_sub1 origin/remove_sub1 &&
710 $command remove_sub1 &&
711 test_superproject_content origin/remove_sub1 &&
712 - ! test -e sub1
712 + ! test -e sub1 &&
713 + test_must_fail git config -f .git/modules/sub1/config core.worktree
714 )
715 '
716 # ... absorbing a .git directory along the way.