From: W. Trevor King Date: Fri, 3 Jan 2014 18:31:22 +0000 (-0800) Subject: Documentation/gitmodules: Only 'update' and 'url' are required X-Git-Tag: v1.8.5.3~9 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=43fda9455c2f9300327e5cf1c532c083354e66b5;p=thirdparty%2Fgit.git 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 Reviewed-by: Heiko Voigt Signed-off-by: Junio C Hamano --- diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt index f7be93f631..347a9f76ee 100644 --- a/Documentation/gitmodules.txt +++ b/Documentation/gitmodules.txt @@ -35,6 +35,8 @@ submodule..url:: linkgit:git-clone[1] or (if it begins with ./ or ../) a location relative to the superproject's origin repository. +In addition, there are a number of optional keys: + submodule..update:: Defines what to do when the submodule is updated by the superproject. If 'checkout' (the default), the new commit specified in the