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 <wking@tremily.us> Reviewed-by: Heiko Voigt <hvoigt@hvoigt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
W. Trevor King committed
Jan 3, 2014 at 10:31 UTC
43fda9455c2f9300327e5cf1c532c083354e66b5
1 file changed
+2
Documentation/gitmodules.txt
+2
@@ -35,6 +35,8 @@ submodule.<name>.url::
35
linkgit:git-clone[1] or (if it begins with ./ or ../) a location
36
relative to the superproject's origin repository.
37
38
+In addition, there are a number of optional keys:
39
+
40
submodule.<name>.update::
41
Defines what to do when the submodule is updated by the superproject.
42
If 'checkout' (the default), the new commit specified in the