Skip to content

Commit d5eec90

Browse files
committed
Merge branch 'sb/doc-config-submodule-update'
* sb/doc-config-submodule-update: Documentation/config: clarify the meaning of submodule.<name>.update
2 parents 69c54c7 + d3a44f6 commit d5eec90

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

Documentation/config.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3085,10 +3085,14 @@ submodule.<name>.url::
30853085
See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
30863086

30873087
submodule.<name>.update::
3088-
The default update procedure for a submodule. This variable
3089-
is populated by `git submodule init` from the
3090-
linkgit:gitmodules[5] file. See description of 'update'
3091-
command in linkgit:git-submodule[1].
3088+
The method by which a submodule is updated by 'git submodule update',
3089+
which is the only affected command, others such as
3090+
'git checkout --recurse-submodules' are unaffected. It exists for
3091+
historical reasons, when 'git submodule' was the only command to
3092+
interact with submodules; settings like `submodule.active`
3093+
and `pull.rebase` are more specific. It is populated by
3094+
`git submodule init` from the linkgit:gitmodules[5] file.
3095+
See description of 'update' command in linkgit:git-submodule[1].
30923096

30933097
submodule.<name>.branch::
30943098
The remote branch name for a submodule, used by `git submodule

0 commit comments

Comments
 (0)