diff options
| author | Junio C Hamano <junio@hera.kernel.org> | 2008-07-17 08:08:47 +0000 |
|---|---|---|
| committer | Junio C Hamano <junio@hera.kernel.org> | 2008-07-17 08:08:47 +0000 |
| commit | f69a0a065df32be5accdda5105d54c580c21e0ee (patch) | |
| tree | 50efb9461bf15dfb63908ece88678b10e0309cc6 /git-submodule.html | |
| parent | f5a9362a72a5a586926fce49c90c93a75cbad2b5 (diff) | |
| download | git-htmldocs-f69a0a065df32be5accdda5105d54c580c21e0ee.tar.gz | |
Autogenerated HTML docs for v1.5.6.3-439-g1e10
Diffstat (limited to 'git-submodule.html')
| -rw-r--r-- | git-submodule.html | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/git-submodule.html b/git-submodule.html index 721a90b09..1ecc633ff 100644 --- a/git-submodule.html +++ b/git-submodule.html @@ -327,6 +327,25 @@ git-submodule(1) Manual Page <em>git submodule</em> [--quiet] update [--init] [--] [<path>…]
<em>git submodule</em> [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>…]</div></div>
</div>
+<h2 id="_description">DESCRIPTION</h2>
+<div class="sectionbody">
+<div class="para"><p>Submodules are a special kind of tree entries which refer to a particular tree
+state in another repository. The tree entry describes
+the existence of a submodule with the given name and the exact revision that
+should be used, while an entry in <tt>.gitmodules</tt> file gives the location of
+the repository.</p></div>
+<div class="para"><p>When checked out, submodules will maintain their own independent repositories
+within their directories; the only link between the submodule and the "parent
+project" is the tree entry within the parent project mentioned above.</p></div>
+<div class="para"><p>This command will manage the tree entries and contents of the gitmodules file
+for you, as well as inspecting the status of your submodules and updating them.
+When adding a new submodule to the tree, the <em>add</em> subcommand is to be used.
+However, when pulling a tree containing submodules, these will not be checked
+out by default; the <em>init</em> and <em>update</em> subcommands will maintain submodules
+checked out and at appropriate revision in your working tree. You can inspect
+the current status of your submodules using the <em>submodule</em> subcommand and get
+an overview of changes <em>update</em> would perform using the <em>summary</em> subcommand.</p></div>
+</div>
<h2 id="_commands">COMMANDS</h2>
<div class="sectionbody">
<div class="vlist"><dl>
@@ -490,7 +509,7 @@ for details.</p></div> </div>
<div id="footer">
<div id="footer-text">
-Last updated 2008-07-15 15:48:35 UTC
+Last updated 2008-07-17 08:08:29 UTC
</div>
</div>
</body>
|