]> Kevux Git Server - rit/commitdiff
doc: list all commands affected by submodule.recurse
authorDamien Robert <damien.olivier.robert@gmail.com>
Mon, 6 Apr 2020 13:57:05 +0000 (15:57 +0200)
committerJunio C Hamano <gitster@pobox.com>
Mon, 6 Apr 2020 20:42:43 +0000 (13:42 -0700)
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>
Documentation/config/submodule.txt
Documentation/gitsubmodules.txt

index b331771..5962f41 100644 (file)
@@ -59,8 +59,9 @@ submodule.active::
 
 submodule.recurse::
        Specifies if commands recurse into submodules by default. This
-       applies to all commands that have a `--recurse-submodules` option,
-       except `clone`.
+       applies to all commands that have a `--recurse-submodules` option
+       (`checkout`, `fetch`, `grep`, `pull`, `push`, `read-tree`, `reset`,
+       `restore` and `switch`) except `clone` and `ls-files`.
        Defaults to false.
 
 submodule.fetchJobs::
index c476f89..f9f4e65 100644 (file)
@@ -271,7 +271,8 @@ will not be checked out by default; You can instruct 'clone' to recurse
 into submodules. The 'init' and 'update' subcommands of 'git submodule'
 will maintain submodules checked out and at an appropriate revision in
 your working tree. Alternatively you can set 'submodule.recurse' to have
-'checkout' recursing into submodules.
+'checkout' recursing into submodules (note that 'submodule.recurse' also
+affects other git commands, see linkgit:git-config[1] for a complete list).
 
 
 SEE ALSO