Re: [PATCH] Clarify role of init command in git-submodules documentation

From: martin f krafft <madduck@madduck.net>
Date: Aug 21, 2007, 21:03 UTC
Message-ID: <20070821210349.GA16702@piper.oerlikon.madduck.net>
In-Reply-To: <20070821202516.GL1070MdfPADPa@greensroom.kotnet.org>

also sprach Sven Verdoolaege <skimo@kotnet.org> [2007.08.21.2225 +0200]:

> >   FILES
> 
> I'm not sure this is the most appropriate name for this section.

I was pondering this as well. BASIC CONCEPT might be better.

> >   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,

It wasn't to me; that's why I am doing all this.

Anyway, when it comes to documentation, I don't think redundancy needs to be avoided as much as otherwise, don't you agree?

> but this is only true if you actually want to use git submodule to
> work with the submodules.

Is it? I tried this and after cloning a repo with submodules, it created the submodule directories alright, but it did not actually check them out/populate them, so they were empty.

> >   a submodule, the submodule's url is copied from the
> >   .gitmodules
> 
> As I mentioned before, this is not strictly true. (see init::)

You're missing something like "... unless the submodule is already registered, in which case it won't be overwritten", right?

Show 8 quoted lines

> >   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).

Well, the sentence says what I wanted to say, but you're absolutely right in that it could be improved. Something like

  Since git-submodule uses the urls in $GIT_DIR/config, which is
  a local configuration file, contributers are free to use urls
  different from the default (e.g. via ssh for those with accounts).

> Other than that, it's definitely an improvement.

Thanks,

-- 
martin;              (greetings from the heart of the sun.)
  \____ echo mailto: !#^."<*>"|tr "<*> mailto:" net@madduck
 
"i like young girls. their stories are shorter."
                                                        -- tom mcguane
 
spamtraps: madduck.bogus@madduck.net