Skip to content

Commit 43fda94

Browse files
wkinggitster
authored andcommitted
Documentation/gitmodules: Only 'update' and 'url' are required
Descriptions for all the settings fell under the initial "Each submodule section also contains the following required keys:". The example shows sections with just 'path' and 'url' entries, which are indeed required, but we should still make the required/optional distinction explicit to clarify that the rest of them are optional. Signed-off-by: W. Trevor King <[email protected]> Reviewed-by: Heiko Voigt <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent b9cf14d commit 43fda94

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

Documentation/gitmodules.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ submodule.<name>.url::
3535
linkgit:git-clone[1] or (if it begins with ./ or ../) a location
3636
relative to the superproject's origin repository.
3737

38+
In addition, there are a number of optional keys:
39+
3840
submodule.<name>.update::
3941
Defines what to do when the submodule is updated by the superproject.
4042
If 'checkout' (the default), the new commit specified in the

0 commit comments

Comments
 (0)