summaryrefslogtreecommitdiff
path: root/Documentation/config/submodule.txt
diff options
context:
space:
mode:
authorLibravatar Damien Robert <damien.olivier.robert@gmail.com>2020-04-06 15:57:07 +0200
committerLibravatar Junio C Hamano <gitster@pobox.com>2020-04-06 13:42:43 -0700
commitd09bc51428274bbb03669e4fb33f74b4edbe40dd (patch)
tree10025c4d77c78816b52c605ea854126d48f89457 /Documentation/config/submodule.txt
parentdoc: document --recurse-submodules for reset and restore (diff)
downloadtgif-d09bc51428274bbb03669e4fb33f74b4edbe40dd.tar.xz
doc: explain how to deactivate submodule.recurse completely
Signed-off-by: Damien Robert <damien.olivier.robert+git@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/config/submodule.txt')
-rw-r--r--Documentation/config/submodule.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/config/submodule.txt b/Documentation/config/submodule.txt
index 5962f41ead..d7a63c8c12 100644
--- a/Documentation/config/submodule.txt
+++ b/Documentation/config/submodule.txt
@@ -63,6 +63,13 @@ submodule.recurse::
(`checkout`, `fetch`, `grep`, `pull`, `push`, `read-tree`, `reset`,
`restore` and `switch`) except `clone` and `ls-files`.
Defaults to false.
+ When set to true, it can be deactivated via the
+ `--no-recurse-submodules` option. Note that some Git commands
+ lacking this option may call some of the above commands affected by
+ `submodule.recurse`; for instance `git remote update` will call
+ `git fetch` but does not have a `--no-recurse-submodules` option.
+ For these commands a workaround is to temporarily change the
+ configuration value by using `git -c submodule.recurse=0`.
submodule.fetchJobs::
Specifies how many submodules are fetched/cloned at the same time.