Skip to content

Commit dd0cb7d

Browse files
Damien Robertgitster
authored andcommitted
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>
1 parent 3bab5d5 commit dd0cb7d

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

Documentation/config/submodule.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,9 @@ submodule.active::
5959

6060
submodule.recurse::
6161
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`.
6465
Defaults to false.
6566

6667
submodule.fetchJobs::

Documentation/gitsubmodules.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,8 @@ will not be checked out by default; You can instruct 'clone' to recurse
271271
into submodules. The 'init' and 'update' subcommands of 'git submodule'
272272
will maintain submodules checked out and at an appropriate revision in
273273
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).
275276

276277

277278
SEE ALSO

0 commit comments

Comments
 (0)