Re: [PATCH] Documentation/git-submodule.txt: Add Description section
- From
- Heikki Orsila <shdl@zakalwe.fi>
- Date
- Jul 15, 2008, 18:37 UTC
- Message-ID
- <20080715183705.GD4379@zakalwe.fi>
- In-Reply-To
- <20080715102119.26321.78530.stgit@localhost>
On Tue, Jul 15, 2008 at 12:22:07PM +0200, Petr Baudis wrote:
> +Submodules are a special kind of tree entries which do not refer to a blob or > +a directory, but to a particular tree in another repository (living at a given > +URL).
Better to say what a submodule is, rather than what it isn't:
"Submodules are a special kind of tree entries which refer to a particular tree in another repository ..."
Also, I think you should make the following explicit:
"A submodule is visible as subdirectory in the working directory. However, the submodule is not part of the main repository. This is a differene to "remotes". In remotes only the contents of other repositories is tracked, but their content is not visible in the working directory."
-- Heikki Orsila heikki.orsila@iki.fi http://www.iki.fi/shd