doc: list all commands affected by submodule.recurse
Note that `ls-files` is not affected, even though it has a `--recurse-submodules` option, so list it as an exception too. Signed-off-by: Damien Robert <damien.olivier.robert+git@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Damien Robert committed
Apr 6, 2020 at 15:57 UTC
dd0cb7dffabf18e0e7251b04fda53d110151e811
2 files changed
+5
-3
Documentation/config/submodule.txt
+3
-2
@@ -59,8 +59,9 @@ submodule.active::
59
60
submodule.recurse::
61
Specifies if commands recurse into submodules by default. This
62
- applies to all commands that have a `--recurse-submodules` option,
63
- except `clone`.
62
+ applies to all commands that have a `--recurse-submodules` option
63
+ (`checkout`, `fetch`, `grep`, `pull`, `push`, `read-tree`, `reset`,
64
+ `restore` and `switch`) except `clone` and `ls-files`.
65
Defaults to false.
66
67
submodule.fetchJobs::
Documentation/gitsubmodules.txt
+2
-1
@@ -271,7 +271,8 @@ will not be checked out by default; You can instruct 'clone' to recurse
271
into submodules. The 'init' and 'update' subcommands of 'git submodule'
272
will maintain submodules checked out and at an appropriate revision in
273
your working tree. Alternatively you can set 'submodule.recurse' to have
274
-'checkout' recursing into submodules.
274
+'checkout' recursing into submodules (note that 'submodule.recurse' also
275
+affects other git commands, see linkgit:git-config[1] for a complete list).
276
277
278
SEE ALSO