doc: clarify description of 'submodule.recurse'
commit878b3997345593d05f7c97a4e17a6c8bb9aba1a2
authorPhilippe Blain <levraiphilippeblain@gmail.com>
Fri, 16 Jul 2021 03:02:57 +0000 (16 03:02 +0000)
committerJunio C Hamano <gitster@pobox.com>
Tue, 20 Jul 2021 21:57:43 +0000 (20 14:57 -0700)
tree022a60013f08334ebaf92511fb8614e9fedfe17d
parentebf3c04b262aa27fbb97f8a0156c2347fecafafb
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 4da9e99e6e (doc: be more precise on
(fetch|push).recurseSubmodules, 2020-04-06).

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/submodule.txt