Skip to content

Commit 878b399

Browse files
phil-blaingitster
authored andcommitted
doc: clarify description of 'submodule.recurse'
The doc for 'submodule.recurse' starts with "Specifies if commands recurse into submodles by default". This is not exactly true of all commands that have a '--recurse-submodules' option. For example, 'git pull --recurse-submodules' does not run 'git pull' in each submodule, but rather runs 'git submodule update --recursive' so that the submodule working trees after the pull matches the commits recorded in the superproject. Clarify that by just saying that it enables '--recurse-submodules'. Note that the way this setting interacts with 'fetch.recurseSubmodules' and 'push.recurseSubmodules', which can have other values than true or false, is already documented since 4da9e99 (doc: be more precise on (fetch|push).recurseSubmodules, 2020-04-06). Signed-off-by: Philippe Blain <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent ebf3c04 commit 878b399

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

Documentation/config/submodule.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,9 @@ submodule.active::
5858
commands. See linkgit:gitsubmodules[7] for details.
5959

6060
submodule.recurse::
61-
Specifies if commands recurse into submodules by default. This
62-
applies to all commands that have a `--recurse-submodules` option
61+
A boolean indicating if commands should enable the `--recurse-submodules`
62+
option by default.
63+
Applies to all commands that support this option
6364
(`checkout`, `fetch`, `grep`, `pull`, `push`, `read-tree`, `reset`,
6465
`restore` and `switch`) except `clone` and `ls-files`.
6566
Defaults to false.

0 commit comments

Comments
 (0)