From: Adrian Ratiu Date: Mon, 08 Sep 2025 14:01:10 GMT Subject: [PATCH v2 03/10] submodule: add gitdir path config override Message-ID: <20250908140117.262205-4-adrian.ratiu@collabora.com> In-Reply-To: <20250908140117.262205-1-adrian.ratiu@collabora.com> This adds an ability to override gitdir paths via config files (not .gitmodules), such that any encoding scheme can be changed and JGit & co don't need to exactly match the default encoding. A new test and a helper are added. The helper will be used by further tests exercising gitdir paths & encodings. Based-on-patch-by: Brandon Williams Signed-off-by: Adrian Ratiu --- Documentation/config/submodule.adoc | 4 ++++ builtin/submodule--helper.c | 17 +++++++++++++++++ submodule.c | 11 +++++++++++ t/lib-verify-submodule-gitdir-path.sh | 20 ++++++++++++++++++++ t/t7400-submodule-basic.sh | 9 +++++++++ t/t9902-completion.sh | 1 + 6 files changed, 62 insertions(+) create mode 100644 t/lib-verify-submodule-gitdir-path.sh diff --git a/Documentation/config/submodule.adoc b/Documentation/config/submodule.adoc index 0672d99117..8f64adfbe3 100644 --- a/Documentation/config/submodule.adoc +++ b/Documentation/config/submodule.adoc @@ -52,6 +52,10 @@ submodule..active:: submodule.active config option. See linkgit:gitsubmodules[7] for details. +submodule..gitdir:: + This option sets the gitdir path for submodule , allowing users + to override the default path or change the default path name encoding. + submodule.active:: A repeated field which contains a pathspec used to match against a submodule's path to determine if the submodule is of interest to git diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c index d06e2fe265..564f7aadf8 100644 --- a/builtin/submodule--helper.c +++ b/builtin/submodule--helper.c @@ -1214,6 +1214,22 @@ static int module_summary(int argc, const char **argv, const char *prefix, return ret; } +static int module_gitdir(int argc, const char **argv, const char *prefix UNUSED, + struct repository *repo UNUSED) +{ + struct strbuf gitdir = STRBUF_INIT; + + if (argc != 2) + usage(_("git submodule--helper gitdir ")); + + submodule_name_to_gitdir(&gitdir, the_repository, argv[1]); + + printf("%s\n", gitdir.buf); + + strbuf_release(&gitdir); + return 0; +} + struct sync_cb { const char *prefix; const char *super_prefix; @@ -3597,6 +3613,7 @@ int cmd_submodule__helper(int argc, NULL }; struct option options[] = { + OPT_SUBCOMMAND("gitdir", &fn, module_gitdir), OPT_SUBCOMMAND("clone", &fn, module_clone), OPT_SUBCOMMAND("add", &fn, module_add), OPT_SUBCOMMAND("update", &fn, module_update), diff --git a/submodule.c b/submodule.c index dbf2244e60..bf78636195 100644 --- a/submodule.c +++ b/submodule.c @@ -2611,6 +2611,17 @@ void submodule_name_to_gitdir(struct strbuf *buf, struct repository *r, * administrators can explicitly set. Nothing has been decided, * so for now, just append the name at the end of the path. */ + char *gitdir_path, *key; + + /* Allow config override. */ + key = xstrfmt("submodule.%s.gitdirpath", submodule_name); + if (!repo_config_get_string(r, key, &gitdir_path)) { + strbuf_addstr(buf, gitdir_path); + free(key); + free(gitdir_path); + return; + } + free(key); /* Legacy behavior: allow existing paths under modules/. */ repo_git_path_append(r, buf, "modules/"); diff --git a/t/lib-verify-submodule-gitdir-path.sh b/t/lib-verify-submodule-gitdir-path.sh new file mode 100644 index 0000000000..ef2a8a47a7 --- /dev/null +++ b/t/lib-verify-submodule-gitdir-path.sh @@ -0,0 +1,20 @@ +# Helper to verify if repo $1 contains a submodule named $2 with gitdir path $3 + +# This does not check filesystem existence. That is done in submodule.c via the +# submodule_name_to_gitdir() API which this helper ends up calling. The gitdirs +# might or might not exist (eg. when adding a new submodule), so this only checks +# the expected configuration path, which might be overridden by the user. + +verify_submodule_gitdir_path() { + repo="$1" && + name="$2" && + path="$3" && + ( + cd "$repo" && + cat >expect <<-EOF && + $(git rev-parse --git-common-dir)/$path + EOF + git submodule--helper gitdir "$name" >actual && + test_cmp expect actual + ) +} diff --git a/t/t7400-submodule-basic.sh b/t/t7400-submodule-basic.sh index 178c386212..a632f47b73 100755 --- a/t/t7400-submodule-basic.sh +++ b/t/t7400-submodule-basic.sh @@ -13,6 +13,7 @@ GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME . ./test-lib.sh +. "$TEST_DIRECTORY"/lib-verify-submodule-gitdir-path.sh test_expect_success 'setup - enable local submodules' ' git config --global protocol.file.allow always @@ -1505,4 +1506,12 @@ test_expect_success 'submodule add fails when name is reused' ' ) ' +test_expect_success 'submodule helper gitdir config overrides' ' + verify_submodule_gitdir_path test-submodule child submodules/child && + test_config -C test-submodule submodule.child.gitdirpath ".git/submodules/custom-child" && + verify_submodule_gitdir_path test-submodule child submodules/custom-child && + test_unconfig -C test-submodule submodule.child.gitdirpath && + verify_submodule_gitdir_path test-submodule child submodules/child +' + test_done diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh index 6650d33fba..928e519267 100755 --- a/t/t9902-completion.sh +++ b/t/t9902-completion.sh @@ -3053,6 +3053,7 @@ test_expect_success 'git config set - variable name - __git_compute_second_level submodule.sub.fetchRecurseSubmodules Z submodule.sub.ignore Z submodule.sub.active Z + submodule.sub.gitdir Z EOF ' -- 2.51.GIT