From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from sender4-op-o12.zoho.com (sender4-op-o12.zoho.com [136.143.188.12]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id BD7B62F5A10 for ; Wed, 7 Jan 2026 23:03:08 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=pass smtp.client-ip=136.143.188.12 ARC-Seal:i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1767826991; cv=pass; b=Mqrf0AR4YK4d8zd73FMB1Z63rGkgfMnco5BF8EofsCA2oroBoXupoVPSEUNS3w0XsKVTX6x1KGqlFv6VWbRStv6lcKZRNqs2rr9pIf/ZiwEy7AVJh4osQIb82ypFSIvSOneVgM5QWtN55Rb5CnrQfNG70DEwWpqPyzbpYc6+pGw= ARC-Message-Signature:i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1767826991; c=relaxed/simple; bh=zQeF7Jamydw8WEvlli48jhYZ5ggIj2qw0P6zwgYt/lI=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=HU2KeNjjLdwzsDhmCtFR7Kt5fele9SeqzwLcaywLIWCYmpfJQ5aGSEa3kIbBgmkQqD5WuRk/z5RhXjfB6BTWwWtJuTHwKJkpHk9JzjnJtAU0CtUxbMgr+yYapzWTKTJVRx5nz4cVlguWBk/fTvSf3j7iVhlrYybAwgNZC+zoppY= ARC-Authentication-Results:i=2; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=collabora.com; spf=pass smtp.mailfrom=collabora.com; dkim=pass (1024-bit key) header.d=collabora.com header.i=adrian.ratiu@collabora.com header.b=QVPm92Qq; arc=pass smtp.client-ip=136.143.188.12 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=collabora.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=collabora.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=collabora.com header.i=adrian.ratiu@collabora.com header.b="QVPm92Qq" ARC-Seal: i=1; a=rsa-sha256; t=1767826974; cv=none; d=zohomail.com; s=zohoarc; b=b5nbFK1ebj8jmRIBAIaKeyabXuoHlMOXjyrq/w/KH5EDh+0fbRCsQZ4W5OCAiCBrUgcfBtcpgrWQ8ot+DDA9ng96BHFtYJnvFOdwWIcMXD3D2zBtTOffxDwulWQ0STe7UwZQ+zTDqgVCHup6aXGV1sxgjmaYpxf1bYNGhNQDZSE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1767826974; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:MIME-Version:Message-ID:References:Subject:Subject:To:To:Message-Id:Reply-To; bh=xyXWgWsogWKf8IQ8CuWgwNKzb582AjuoGpHsNInySTk=; b=kPiQSFoV61QUQ1iwOkab6yeN3wQXse3pko8ezZpcHjgYRCvnkNZoLOdYcS5Mucks0aWUJEkNq2DQ954fr8h6+oi35joDp2G6T9m9HwszPICasnjOk+lBl0FgHCEykB6JP0/JkoMd77wD7QKl/tBodT12x/vWMNVx5vhCq1ROEY0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass header.i=collabora.com; spf=pass smtp.mailfrom=adrian.ratiu@collabora.com; dmarc=pass header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1767826974; s=zohomail; d=collabora.com; i=adrian.ratiu@collabora.com; h=From:From:To:To:Cc:Cc:Subject:Subject:Date:Date:Message-ID:In-Reply-To:References:MIME-Version:Content-Transfer-Encoding:Message-Id:Reply-To; bh=xyXWgWsogWKf8IQ8CuWgwNKzb582AjuoGpHsNInySTk=; b=QVPm92Qq0yWcCwJ6CQjUD3MABCTo3+l/tCUNg06F2HOTUbM03B0ML37G3Gf6A3eV gjD8cgYbB29y/3s2Xnahd7JdHBOwaDPjNnHBA34M4fXKYRrPwmBY8LN2MRYAGN5aq+3 zn/VU8HpPwQnGmA2PVdyGnzy0FYlYdajekWW1I44= Received: by mx.zohomail.com with SMTPS id 1767826972998364.28731793127633; Wed, 7 Jan 2026 15:02:52 -0800 (PST) From: Adrian Ratiu To: git@vger.kernel.org Cc: Emily Shaffer , Rodrigo Damazio Bovendorp , Jeff King , Junio C Hamano , Aaron Schrab , Jonathan Nieder , Patrick Steinhardt , Josh Steadmon , Ben Knoble , Phillip Wood , Adrian Ratiu Subject: [PATCH v8 05/11] submodule: allow runtime enabling extensions.submodulePathConfig Date: Thu, 8 Jan 2026 01:01:39 +0200 Message-ID: <20260107230145.517562-6-adrian.ratiu@collabora.com> X-Mailer: git-send-email 2.51.2 In-Reply-To: <20260107230145.517562-1-adrian.ratiu@collabora.com> References: <20250816213642.3517822-1-adrian.ratiu@collabora.com> <20260107230145.517562-1-adrian.ratiu@collabora.com> Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-ZohoMailClient: External Add a new config `init.defaultSubmodulePathConfig` which allows enabling `extensions.submodulePathConfig` for new submodules by default (those created via git init or clone). Important: setting init.defaultSubmodulePathConfig = true does not globally enable `extensions.submodulePathConfig`. Existing repositories will still have the extension disabled and will require migration (for example via git submodule--helper command added in the next commit). Suggested-by: Patrick Steinhardt Suggested-by: Junio C Hamano Signed-off-by: Adrian Ratiu --- Documentation/config/extensions.adoc | 4 + Documentation/config/init.adoc | 6 + setup.c | 10 ++ t/t7425-submodule-gitdir-path-extension.sh | 125 +++++++++++++++++++++ 4 files changed, 145 insertions(+) diff --git a/Documentation/config/extensions.adoc b/Documentation/config/extensions.adoc index f4f57c9114..e8d9d9a19a 100644 --- a/Documentation/config/extensions.adoc +++ b/Documentation/config/extensions.adoc @@ -95,6 +95,10 @@ Git will error out if a module does not have a corresponding Existing (pre-extension) submodules need to be migrated by adding the missing config entries. This is done manually for now, e.g. for each submodule: `git config submodule..gitdir .git/modules/`. ++ +The extension can be enabled automatically for new repositories by setting +`init.defaultSubmodulePathConfig` to `true`, for example by running +`git config --global init.defaultSubmodulePathConfig true`. worktreeConfig::: If enabled, then worktrees will load config settings from the diff --git a/Documentation/config/init.adoc b/Documentation/config/init.adoc index e45b2a8121..7b4abdaf8b 100644 --- a/Documentation/config/init.adoc +++ b/Documentation/config/init.adoc @@ -18,3 +18,9 @@ endif::[] See `--ref-format=` in linkgit:git-init[1]. Both the command line option and the `GIT_DEFAULT_REF_FORMAT` environment variable take precedence over this config. + +init.defaultSubmodulePathConfig:: + A boolean that specifies if `git init` and `git clone` should + automatically set `extensions.submodulePathConfig` to `true`. This + allows all new repositories to automatically use the submodule path + extension. Defaults to `false` when unset. diff --git a/setup.c b/setup.c index 428427d689..0378483b69 100644 --- a/setup.c +++ b/setup.c @@ -2310,6 +2310,7 @@ void initialize_repository_version(int hash_algo, { struct strbuf repo_version = STRBUF_INIT; int target_version = GIT_REPO_VERSION; + int default_submodule_path_config = 0; /* * Note that we initialize the repository version to 1 when the ref @@ -2348,6 +2349,15 @@ void initialize_repository_version(int hash_algo, clear_repository_format(&repo_fmt); } + repo_config_get_bool(the_repository, "init.defaultSubmodulePathConfig", + &default_submodule_path_config); + if (default_submodule_path_config) { + /* extensions.submodulepathconfig requires at least version 1 */ + if (target_version == 0) + target_version = 1; + repo_config_set(the_repository, "extensions.submodulepathconfig", "true"); + } + strbuf_addf(&repo_version, "%d", target_version); repo_config_set(the_repository, "core.repositoryformatversion", repo_version.buf); diff --git a/t/t7425-submodule-gitdir-path-extension.sh b/t/t7425-submodule-gitdir-path-extension.sh index 453183e27c..6cb844e809 100755 --- a/t/t7425-submodule-gitdir-path-extension.sh +++ b/t/t7425-submodule-gitdir-path-extension.sh @@ -157,4 +157,129 @@ test_expect_success 'fetch mixed submodule changes and verify updates' ' ) ' +test_expect_success '`git init` respects init.defaultSubmodulePathConfig' ' + git config --global init.defaultSubmodulePathConfig true && + git init repo-init && + git -C repo-init config extensions.submodulePathConfig > actual && + echo true > expect && + test_cmp expect actual && + # create a submodule and check gitdir + ( + cd repo-init && + git init -b main sub && + test_commit -C sub sub-initial && + git submodule add ./sub sub && + git config submodule.sub.gitdir > actual && + echo ".git/modules/sub" > expect && + test_cmp expect actual + ) && + git config --global --unset init.defaultSubmodulePathConfig +' + +test_expect_success '`git init` does not set extension by default' ' + git init upstream && + test_commit -C upstream initial && + test_must_fail git -C upstream config extensions.submodulePathConfig && + # create a pair of submodules and check gitdir is not created + git init -b main sub && + test_commit -C sub sub-initial && + ( + cd upstream && + git submodule add ../sub sub1 && + test_path_is_dir .git/modules/sub1 && + test_must_fail git config submodule.sub1.gitdir && + git submodule add ../sub sub2 && + test_path_is_dir .git/modules/sub2 && + test_must_fail git config submodule.sub2.gitdir && + git commit -m "Add submodules" + ) +' + +test_expect_success '`git clone` does not set extension by default' ' + test_when_finished "rm -rf repo-clone-no-ext" && + git clone upstream repo-clone-no-ext && + ( + cd repo-clone-no-ext && + + test_must_fail git config extensions.submodulePathConfig && + test_path_is_missing .git/modules/sub1 && + test_path_is_missing .git/modules/sub2 && + + # create a submodule and check gitdir is not created + git submodule add ../sub sub3 && + test_must_fail git config submodule.sub3.gitdir + ) +' + +test_expect_success '`git clone --recurse-submodules` does not set extension by default' ' + test_when_finished "rm -rf repo-clone-no-ext" && + git clone --recurse-submodules upstream repo-clone-no-ext && + ( + cd repo-clone-no-ext && + + # verify that that submodules do not have gitdir set + test_must_fail git config extensions.submodulePathConfig && + test_path_is_dir .git/modules/sub1 && + test_must_fail git config submodule.sub1.gitdir && + test_path_is_dir .git/modules/sub2 && + test_must_fail git config submodule.sub2.gitdir && + + # create another submodule and check that gitdir is not created + git submodule add ../sub sub3 && + test_path_is_dir .git/modules/sub3 && + test_must_fail git config submodule.sub3.gitdir + ) + +' + +test_expect_success '`git clone` respects init.defaultSubmodulePathConfig' ' + test_when_finished "rm -rf repo-clone" && + git config --global init.defaultSubmodulePathConfig true && + git clone upstream repo-clone && + ( + cd repo-clone && + + # verify new repo extension is inherited from global config + git config extensions.submodulePathConfig > actual && + echo true > expect && + test_cmp expect actual && + + # new submodule has a gitdir config + git submodule add ../sub sub && + test_path_is_dir .git/modules/sub && + git config submodule.sub.gitdir > actual && + echo ".git/modules/sub" > expect && + test_cmp expect actual + ) && + git config --global --unset init.defaultSubmodulePathConfig +' + +test_expect_success '`git clone --recurse-submodules` respects init.defaultSubmodulePathConfig' ' + test_when_finished "rm -rf repo-clone-recursive" && + git config --global init.defaultSubmodulePathConfig true && + git clone --recurse-submodules upstream repo-clone-recursive && + ( + cd repo-clone-recursive && + + # verify new repo extension is inherited from global config + git config extensions.submodulePathConfig > actual && + echo true > expect && + test_cmp expect actual && + + # previous submodules should exist + git config submodule.sub1.gitdir && + git config submodule.sub2.gitdir && + test_path_is_dir .git/modules/sub1 && + test_path_is_dir .git/modules/sub2 && + + # create another submodule and check that gitdir is created + git submodule add ../sub new-sub && + test_path_is_dir .git/modules/new-sub && + git config submodule.new-sub.gitdir > actual && + echo ".git/modules/new-sub" > expect && + test_cmp expect actual + ) && + git config --global --unset init.defaultSubmodulePathConfig +' + test_done -- 2.51.2