diff options
| author | Adrian Ratiu <adrian.ratiu@collabora.com> | 2026-01-12 20:46:27 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2026-01-12 11:56:56 -0800 |
| commit | e14349d58eeae0eac23bf7f740d22f51fc90a49d (patch) | |
| tree | 43f98c789332a4d7e9ba861b1d32501eff127328 /Documentation | |
| parent | c349bad72969d59758e1294b4e9964dccd967fa0 (diff) | |
| download | git-e14349d58eeae0eac23bf7f740d22f51fc90a49d.tar.xz | |
submodule--helper: add gitdir migration command
Manually running
"git config submodule.<name>.gitdir .git/modules/<name>"
for each submodule can be impractical, so add a migration command to
submodule--helper to automatically create configs for all submodules
as required by extensions.submodulePathConfig.
The command calls create_default_gitdir_config() which validates the
gitdir paths before adding the configs.
Suggested-by: Junio C Hamano <gitster@pobox.com>
Suggested-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Adrian Ratiu <adrian.ratiu@collabora.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/config/extensions.adoc | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/config/extensions.adoc b/Documentation/config/extensions.adoc index e8d9d9a19a..2aef3315b1 100644 --- a/Documentation/config/extensions.adoc +++ b/Documentation/config/extensions.adoc @@ -93,8 +93,10 @@ Git will error out if a module does not have a corresponding `submodule.<name>.gitdir` set. + 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.<name>.gitdir .git/modules/<name>`. +config entries. This can be done manually, e.g. for each submodule: +`git config submodule.<name>.gitdir .git/modules/<name>`, or via the +`git submodule--helper migrate-gitdir-configs` command which iterates over all +submodules and attempts to migrate them. + The extension can be enabled automatically for new repositories by setting `init.defaultSubmodulePathConfig` to `true`, for example by running |