[v6,3/5] doc: explain how to deactivate submodule.recurse completely
diff mbox series

Message ID 20200406135709.60041-4-damien.olivier.robert+git@gmail.com
State New
Headers show
  • doc: --recurse-submodules
Related show

Commit Message

Damien Robert April 6, 2020, 1:57 p.m. UTC
Signed-off-by: Damien Robert <damien.olivier.robert+git@gmail.com>
 Documentation/config/submodule.txt | 7 +++++++
 1 file changed, 7 insertions(+)

diff mbox series

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`.
 	Specifies how many submodules are fetched/cloned at the same time.