aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2021-08-02 14:06:39 -0700
committerJunio C Hamano <gitster@pobox.com>2021-08-02 14:06:39 -0700
commitc01881845c6ecf8e5449c54cd8a0ddddf182d280 (patch)
tree6d9c272c0d8e73a321bc1b4c2829ce7568df2526
parentMerge branch 'tb/bitmap-type-filter-comment-fix' (diff)
parentdoc: clarify description of 'submodule.recurse' (diff)
downloadgit-c01881845c6ecf8e5449c54cd8a0ddddf182d280.tar.xz
git-c01881845c6ecf8e5449c54cd8a0ddddf182d280.zip
Merge branch 'pb/submodule-recurse-doc'
Doc update. * pb/submodule-recurse-doc: doc: clarify description of 'submodule.recurse'
-rw-r--r--Documentation/config/submodule.txt5
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/config/submodule.txt b/Documentation/config/submodule.txt
index d7a63c8c12b..ee454f8126a 100644
--- a/Documentation/config/submodule.txt
+++ b/Documentation/config/submodule.txt
@@ -58,8 +58,9 @@ submodule.active::
commands. See linkgit:gitsubmodules[7] for details.
submodule.recurse::
- Specifies if commands recurse into submodules by default. This
- applies to all commands that have a `--recurse-submodules` option
+ A boolean indicating if commands should enable the `--recurse-submodules`
+ option by default.
+ Applies to all commands that support this option
(`checkout`, `fetch`, `grep`, `pull`, `push`, `read-tree`, `reset`,
`restore` and `switch`) except `clone` and `ls-files`.
Defaults to false.