summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2017-09-29 02:23:44 (GMT)
committerJunio C Hamano <gitster@pobox.com>2017-09-29 02:23:44 (GMT)
commitd5eec90970d796ac5ddcd7cdc85d0fc828f7ceda (patch)
treedd19b5aa8f1ae5bf7624d12cd79db0ffdef2dfa0 /Documentation
parent69c54c72845ebc686d0f4bdd8d44b06f799b0a80 (diff)
parentd3a44f637ecb0a4033e521a4166710aa2f080796 (diff)
downloadgit-d5eec90970d796ac5ddcd7cdc85d0fc828f7ceda.zip
git-d5eec90970d796ac5ddcd7cdc85d0fc828f7ceda.tar.gz
git-d5eec90970d796ac5ddcd7cdc85d0fc828f7ceda.tar.bz2
Merge branch 'sb/doc-config-submodule-update'
* sb/doc-config-submodule-update: Documentation/config: clarify the meaning of submodule.<name>.update
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/config.txt12
1 files changed, 8 insertions, 4 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt
index dc4e3f5..1ac0ae6 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -3085,10 +3085,14 @@ submodule.<name>.url::
See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
submodule.<name>.update::
- The default update procedure for a submodule. This variable
- is populated by `git submodule init` from the
- linkgit:gitmodules[5] file. See description of 'update'
- command in linkgit:git-submodule[1].
+ The method by which a submodule is updated by 'git submodule update',
+ which is the only affected command, others such as
+ 'git checkout --recurse-submodules' are unaffected. It exists for
+ historical reasons, when 'git submodule' was the only command to
+ interact with submodules; settings like `submodule.active`
+ and `pull.rebase` are more specific. It is populated by
+ `git submodule init` from the linkgit:gitmodules[5] file.
+ See description of 'update' command in linkgit:git-submodule[1].
submodule.<name>.branch::
The remote branch name for a submodule, used by `git submodule