[PATCH] Documentation/gitmodules: Only 'update' and 'url' are required

[PATCH] Documentation/gitmodules: Only 'update' and 'url' are required

[W. Trevor King]

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

Re: [PATCH] Documentation/gitmodules: Only 'update' and 'url' are required

[Heiko Voigt]

On Fri, Jan 03, 2014 at 10:31:22AM -0800, W. Trevor King wrote:
> 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

You mean:

	...with just 'path' and 'url' entries...

?

Other than that, the patch looks good to me.

Cheers Heiko

Re: [PATCH] Documentation/gitmodules: Only 'update' and 'url' are required

[W. Trevor King]

[-- Attachment #1: Type: text/plain, Size: 732 bytes --]

On Sat, Jan 04, 2014 at 11:17:54PM +0100, Heiko Voigt wrote:
> On Fri, Jan 03, 2014 at 10:31:22AM -0800, W. Trevor King wrote:
> > 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
> 
> You mean:
> 
> 	...with just 'path' and 'url' entries...

Oops, yes.  And in the summary/subject as well.  I can submit a v2 if
folks want, or just deputize Junio to fix it if/when this is applied.

Cheers,
Trevor

-- 
This email may be signed or encrypted with GnuPG (http://www.gnupg.org).
For more information, see http://en.wikipedia.org/wiki/Pretty_Good_Privacy

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 836 bytes --]