diff options
| author | W. Trevor King <wking@tremily.us> | 2014-01-03 18:31:22 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2014-01-06 17:08:18 (GMT) |
| commit | 43fda9455c2f9300327e5cf1c532c083354e66b5 (patch) | |
| tree | 8db6072092da95278d028325306e837b02e95d43 /Documentation | |
| parent | b9cf14d43b221fc2cce07b63d1dca408c17946e3 (diff) | |
| download | git-43fda9455c2f9300327e5cf1c532c083354e66b5.zip git-43fda9455c2f9300327e5cf1c532c083354e66b5.tar.gz git-43fda9455c2f9300327e5cf1c532c083354e66b5.tar.bz2 | |
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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/gitmodules.txt | 2 |
1 files changed, 2 insertions, 0 deletions
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 |