aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/config/extensions.adoc4
-rw-r--r--Documentation/config/init.adoc6
2 files changed, 10 insertions, 0 deletions
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.<name>.gitdir .git/modules/<name>`.
++
+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.