git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
SVSven Verdoolaege <skimo@kotnet.org>
Date
Aug 17, 2007, 10:36 UTC
Message-ID
<20070817103652.GK1070MdfPADPa@greensroom.kotnet.org>
In-Reply-To
<20070817100815.GC28477@piper.oerlikon.madduck.net>
On Fri, Aug 17, 2007 at 12:08:15PM +0200, martin f krafft wrote:
Show 13 quoted lines
> 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.

Show 6 quoted lines
>  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
Previous: martin f krafftNext: martin f. krafft
Message 4 of 13 in “clarify need for init in git-submodules documentation”
  1. clarify need for init in git-submodules documentationmartin f. krafft, Aug 16, 2007
  2. Sven VerdoolaegeAug 17, 2007
  3. martin f krafftAug 17, 2007
  4. Sven VerdoolaegeAug 17, 2007
  5. Clarify role of init command in git-submodules documentationmartin f. krafft, Aug 20, 2007
  6. Sven VerdoolaegeAug 20, 2007
  7. Junio C HamanoAug 20, 2007
  8. martin f krafftAug 21, 2007
  9. Sven VerdoolaegeAug 21, 2007
  10. martin f krafftAug 21, 2007
  11. Sven VerdoolaegeAug 22, 2007
  12. martin f krafftAug 22, 2007
  13. Not setting M-F-T, keeping people on Cc (was: [PATCH] clarify need for init in git-submodules documentation)martin f krafft, Aug 20, 2007

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.