[PATCH] Documentation/gitmodules: Only 'update' and 'url' are required
- From
W. Trevor King <wking@tremily.us>
- Date
- Jan 3, 2014, 18:31 UTC
- Message-ID
- <c22c81472bb8b8943d34bdf1ac9ef61f5a489a16.1388773808.git.wking@tremily.us>
From: "W. Trevor King" <wking@tremily.us>
Before this commit, all the settings fell under the initial "Each submodule section also contains the following required keys:". The example shows sections with just 'update' and 'url' entries, but we should still make the required/optional distinction explicit for the descriptions.
Signed-off-by: W. Trevor King <wking@tremily.us> --- Documentation/gitmodules.txt | 2 ++ 1 file changed, 2 insertions(+)
diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt index f7be93f..347a9f7 100644 --- a/Documentation/gitmodules.txt +++ b/Documentation/gitmodules.txt @@ -35,6 +35,8 @@ submodule.<name>.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.<name>.update:: Defines what to do when the submodule is updated by the superproject. If 'checkout' (the default), the new commit specified in the
-- 1.8.5.2.gaa5d535.dirty