Re: [PATCH] Clarify role of init command in git-submodules documentation
- From
- Sven Verdoolaege <skimo@kotnet.org>
- Date
- Aug 21, 2007, 20:25 UTC
- Message-ID
- <20070821202516.GL1070MdfPADPa@greensroom.kotnet.org>
- In-Reply-To
- <20070821180218.GA14739@piper.oerlikon.madduck.net>
On Tue, Aug 21, 2007 at 08:02:18PM +0200, martin f krafft wrote:
> FILES
I'm not sure this is the most appropriate name for this section.
Show 10 quoted lines
> A repository with submodules is identified by a .gitmodules file > in the repository's top level (see gitlink:gitmodules[5]). This > file specifies for each submodule its name, the url of the > submodule's repository, as well as the location of the submodule > within the (super)project's repository. As the .gitmodules file > contains information shared by all users of the repository, it is > typically tracked. > > Users who clone the project's repository need to initialize each > submodule before they can work with it. By initializing
I suppose this is implicit in the git submodule man page, but this is only true if you actually want to use git submodule to work with the submodules.
> a submodule, the submodule's url is copied from the .gitmodules
As I mentioned before, this is not strictly true. (see init::)
> By pulling the submodule urls out of $GIT_DIR/config, > git-submodule allows contributors to use different urls (e.g. via
I'm not a native speaker, but to me that sounds like you are _not_ using the urls in $GIT_DIR/config. That is, I read that as: they are pulled out of $GIT_DIR/config (and then placed somewhere else).
Other than that, it's definitely an improvement.
skimo