Re: [PATCH] clarify need for init in git-submodules documentation

[Sven Verdoolaege <skimo@kotnet.org>]

On Fri, Aug 17, 2007 at 12:08:15PM +0200, martin f krafft wrote:
> also sprach Sven Verdoolaege <skimo@kotnet.org> [2007.08.17.1131 +0200]:
> > This is not true.  The url (which is local information) is taken from .git/config,
> > the name/path relation (which is shared information) is taken from .gitmodules.
> 
> If you approve of this change, I shall prepare a new patch:
> 
> diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
> index b1a4f95..2f69047 100644
> --- a/Documentation/git-submodule.txt
> +++ b/Documentation/git-submodule.txt
> @@ -71,8 +71,9 @@ to each submodule url is "submodule.$name.url".
>  
>  The file .gitmodules serves default configuration data to users who cloned the

This still seems to suggest that the only purpose of .gitmodules is to
contain default configuration data.  I think you should restrict the
whole paragraph to talking about URLs.  Btw, please be consistent about
the spelling of URL.  Either use "url" or change the "url"s in the remainder
of the text to "URL".
Oh, and CC Lars on your patch.

>  repository. In order to work with submodules, these data need to be copied to
> -$GIT_DIR/config with `git-submodule init`. Only the data in $GIT_DIR/config
> -are used for `git-submodule update`.
> +$GIT_DIR/config with `git-submodule init`. Only the URL in $GIT_DIR/config
> +is used for `git-submodule update`, as it is local information. The name/path
> +relation is taken from the .gitmodules file, as it is shared data.

There is no mention in this man page of this relationship, so I think
you should either add a description or drop the last sentence.
I'm also not sure if local/shared are the best way to describe the
distinction in a manual page.  I was only trying to make it clear to you.

skimo