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

[PATCH v6 3/5] submodule: record superproject gitdir during absorbgitdirs

From
Emily Shaffer <emilyshaffer@google.com>
Date
Nov 17, 2021, 00:56 UTC
Message-ID
<20211117005701.371808-4-emilyshaffer@google.com>
In-Reply-To
<20211117005701.371808-1-emilyshaffer@google.com>

Already during 'git submodule add' we record a pointer to the superproject's gitdir. However, this doesn't help brand-new submodules created with 'git init' and later absorbed with 'git submodule absorbgitdirs'. Let's start adding that pointer during 'git submodule absorbgitdirs' too.

Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
---
 submodule.c                        | 23 +++++++++
 t/t7412-submodule-absorbgitdirs.sh | 82 +++++++++++++++++++++++++++++-
 2 files changed, 103 insertions(+), 2 deletions(-)
diff --git a/submodule.c b/submodule.c
index c689070524..d7395c7551 100644
--- a/submodule.c
+++ b/submodule.c
@@ -2097,6 +2097,9 @@ static void relocate_single_git_dir_into_superproject(const char *path)
 	char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
 	struct strbuf new_gitdir = STRBUF_INIT;
 	const struct submodule *sub;
+	struct config_set sub_cs;
+	struct strbuf config_path = STRBUF_INIT, sb = STRBUF_INIT;
+	int tmp;
 
 	if (submodule_uses_worktrees(path))
 		die(_("relocate_gitdir for submodule '%s' with "
@@ -2127,6 +2130,26 @@ static void relocate_single_git_dir_into_superproject(const char *path)
 
 	relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
 
+	/*
+	 * Note location of superproject's gitdir. Because the submodule already
+	 * has a gitdir and local config, we can store this pointer from
+	 * worktree config to worktree config, if the submodule has
+	 * extensions.worktreeConfig set.
+	 */
+	strbuf_addf(&config_path, "%s/config", real_new_git_dir);
+	git_configset_init(&sub_cs);
+	git_configset_add_file(&sub_cs, config_path.buf);
+	/* return 0 indicates config was found - we have a worktree config */
+	if (!git_configset_get_bool(&sub_cs, "extensions.worktreeConfig", &tmp))
+		strbuf_addstr(&config_path, ".worktree");
+
+	git_config_set_in_file(config_path.buf, "submodule.superprojectGitdir",
+			       relative_path(absolute_path(get_git_dir()),
+					     real_new_git_dir, &sb));
+
+	git_configset_clear(&sub_cs);
+	strbuf_release(&config_path);
+	strbuf_release(&sb);
 	free(old_git_dir);
 	free(real_old_git_dir);
 	free(real_new_git_dir);
diff --git a/t/t7412-submodule-absorbgitdirs.sh b/t/t7412-submodule-absorbgitdirs.sh
index 1cfa150768..5753f90268 100755
--- a/t/t7412-submodule-absorbgitdirs.sh
+++ b/t/t7412-submodule-absorbgitdirs.sh
@@ -30,7 +30,17 @@ test_expect_success 'absorb the git dir' '
 	git status >actual.1 &&
 	git -C sub1 rev-parse HEAD >actual.2 &&
 	test_cmp expect.1 actual.1 &&
-	test_cmp expect.2 actual.2
+	test_cmp expect.2 actual.2 &&
+
+	# make sure the submodule cached the superproject gitdir correctly
+	submodule_gitdir="$(git -C sub1 rev-parse --path-format=absolute --git-common-dir)" &&
+	superproject_gitdir="$(git rev-parse --path-format=absolute --git-common-dir)" &&
+
+	test-tool path-utils relative_path "$superproject_gitdir" \
+		"$submodule_gitdir" >expect &&
+	git -C sub1 config submodule.superprojectGitDir >actual &&
+
+	test_cmp expect actual
 '
 
 test_expect_success 'absorbing does not fail for deinitialized submodules' '
@@ -61,7 +71,16 @@ test_expect_success 'absorb the git dir in a nested submodule' '
 	git status >actual.1 &&
 	git -C sub1/nested rev-parse HEAD >actual.2 &&
 	test_cmp expect.1 actual.1 &&
-	test_cmp expect.2 actual.2
+	test_cmp expect.2 actual.2 &&
+
+	sub1_gitdir="$(git -C sub1 rev-parse --path-format=absolute --git-common-dir)" &&
+	sub1_nested_gitdir="$(git -C sub1/nested rev-parse --path-format=absolute --git-common-dir)" &&
+
+	test-tool path-utils relative_path "$sub1_gitdir" "$sub1_nested_gitdir" \
+		>expect &&
+	git -C sub1/nested config submodule.superprojectGitDir >actual &&
+
+	test_cmp expect actual
 '
 
 test_expect_success 're-setup nested submodule' '
@@ -130,4 +149,63 @@ test_expect_success 'absorbing fails for a submodule with multiple worktrees' '
 	test_i18ngrep "not supported" error
 '
 
+test_expect_success 'absorbgitdirs works when called from a superproject worktree' '
+	# set up a worktree of the superproject
+	git worktree add wt &&
+	(
+	cd wt &&
+
+	# create a new unembedded git dir
+	git init sub4 &&
+	test_commit -C sub4 first &&
+	git submodule add ./sub4 &&
+	test_tick &&
+
+	# absorb the git dir
+	git submodule absorbgitdirs sub4 &&
+
+	# make sure the submodule noted the superproject gitdir correctly
+	submodule_gitdir="$(git -C sub4 rev-parse --absolute-git-dir)" &&
+	superproject_gitdir="$(git rev-parse --absolute-git-dir)" &&
+
+	test-tool path-utils relative_path "$superproject_gitdir" \
+		"$submodule_gitdir" >expect &&
+	git -C sub4 config submodule.superprojectGitDir >actual &&
+
+	test_cmp expect actual
+	)
+'
+
+test_expect_success 'absorbgitdirs works with a submodule with worktree config' '
+	# reuse the worktree of the superproject
+	(
+	cd wt &&
+
+	# create a new unembedded git dir
+	git init sub5 &&
+	test_commit -C sub5 first &&
+	git submodule add ./sub5 &&
+	test_tick &&
+
+	# turn on worktree configs for submodule
+	git -C sub5 config extensions.worktreeConfig true &&
+
+	# absorb the git dir
+	git submodule absorbgitdirs sub5 &&
+
+	# make sure the submodule noted the superproject gitdir correctly
+	submodule_gitdir="$(git -C sub5 rev-parse --absolute-git-dir)" &&
+	superproject_gitdir="$(git rev-parse --absolute-git-dir)" &&
+
+	test-tool path-utils relative_path "$superproject_gitdir" \
+		"$submodule_gitdir" >expect &&
+	git -C sub5 config submodule.superprojectGitDir >actual &&
+
+	test_cmp expect actual &&
+
+	# make sure the config went into the submodule config.worktree
+	test_file_not_empty "$submodule_gitdir/config.worktree"
+	)
+'
+
 test_done
-- 
2.34.0.rc1.387.gb447b232ab-goog
Previous: Jonathan TanNext: Emily Shaffer
Message 5 of 64 in “teach submodules to know they're submodules”
  1. 0/5 teach submodules to know they're submodulesEmily Shaffer, Nov 17, 2021
  2. 1/5 t7400-submodule-basic: modernize inspect() helperEmily Shaffer, Nov 17, 2021
  3. 2/5 introduce submodule.superprojectGitDir recordEmily Shaffer, Nov 17, 2021
  4. Jonathan TanNov 17, 2021
  5. 3/5 submodule: record superproject gitdir during absorbgitdirsEmily Shaffer, Nov 17, 2021
  6. 4/5 submodule: record superproject gitdir during 'update'Emily Shaffer, Nov 17, 2021
  7. 5/5 submodule: use config to find superproject worktreeEmily Shaffer, Nov 17, 2021
  8. 0/2 submodule: test what happens if submodule.superprojectGitDir isn't aroundÆvar Arnfjörð Bjarmason, Nov 17, 2021
  9. 1/2 submodule tests: fix potentially broken "config .. --unset"Ævar Arnfjörð Bjarmason, Nov 17, 2021
  10. 2/2 submodule: add test mode for checking absence of "superProjectGitDir"Ævar Arnfjörð Bjarmason, Nov 17, 2021
  11. Emily ShafferNov 23, 2021
  12. Ævar Arnfjörð BjarmasonNov 24, 2021
  13. Jonathan TanNov 17, 2021
  14. Emily ShafferNov 23, 2021
  15. 0/5 teach submodules to know they're submodulesEmily Shaffer, Feb 3, 2022
  16. 1/4 t7400-submodule-basic: modernize inspect() helperEmily Shaffer, Feb 3, 2022
  17. 2/4 introduce submodule.superprojectGitDir recordEmily Shaffer, Feb 3, 2022
  18. 3/4 submodule: record superproject gitdir during absorbgitdirsEmily Shaffer, Feb 3, 2022
  19. 4/4 submodule: record superproject gitdir during 'update'Emily Shaffer, Feb 3, 2022
  20. Junio C HamanoFeb 3, 2022
  21. Ævar Arnfjörð BjarmasonFeb 4, 2022
  22. Junio C HamanoFeb 4, 2022
  23. Jonathan NiederFeb 7, 2022
  24. Junio C HamanoFeb 7, 2022
  25. Jonathan NiederFeb 8, 2022
  26. Junio C HamanoFeb 8, 2022
  27. Emily ShafferFeb 10, 2022
  28. Jonathan NiederFeb 10, 2022
  29. Ævar Arnfjörð BjarmasonFeb 12, 2022
  30. Junio C HamanoFeb 13, 2022
  31. 0/3 teach submodules to know they're submodulesEmily Shaffer, Mar 1, 2022
  32. 1/3 t7400-submodule-basic: modernize inspect() helperEmily Shaffer, Mar 1, 2022
  33. 2/3 introduce submodule.hasSuperproject recordEmily Shaffer, Mar 1, 2022
  34. Junio C HamanoMar 1, 2022
  35. Emily ShafferMar 8, 2022
  36. Glen ChooMar 8, 2022
  37. Glen ChooMar 8, 2022
  38. 3/3 rev-parse: short-circuit superproject worktree when config unsetEmily Shaffer, Mar 1, 2022
  39. Junio C HamanoMar 1, 2022
  40. Emily ShafferMar 9, 2022
  41. Junio C HamanoMar 1, 2022
  42. Emily ShafferMar 8, 2022
  43. 0/3 teach submodules to know they're submodulesEmily Shaffer, Mar 10, 2022
  44. 1/3 t7400-submodule-basic: modernize inspect() helperEmily Shaffer, Mar 10, 2022
  45. 2/3 introduce submodule.hasSuperproject recordEmily Shaffer, Mar 10, 2022
  46. Junio C HamanoMar 10, 2022
  47. Glen ChooMar 10, 2022
  48. Glen ChooMar 10, 2022
  49. Junio C HamanoMar 10, 2022
  50. Glen ChooMar 10, 2022
  51. Glen ChooMar 10, 2022
  52. Emily ShafferMar 15, 2022
  53. Emily ShafferMar 15, 2022
  54. Glen ChooMar 15, 2022
  55. Emily ShafferMar 15, 2022
  56. Junio C HamanoMar 15, 2022
  57. Junio C HamanoMar 10, 2022
  58. Glen ChooMar 10, 2022
  59. Emily ShafferMar 15, 2022
  60. 3/3 rev-parse: short-circuit superproject worktree when config unsetEmily Shaffer, Mar 10, 2022
  61. Junio C HamanoMar 10, 2022
  62. Eric SunshineMar 10, 2022
  63. Ævar Arnfjörð BjarmasonMar 11, 2022
  64. Junio C HamanoMar 13, 2022

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.