summaryrefslogtreecommitdiffstats
path: root/git-submodule.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2015-06-11 12:37:48 -0700
committerJunio C Hamano <gitster@pobox.com>2015-06-11 12:37:48 -0700
commit8c5d59493937c1482fea3e1c3d494aba0abe1005 (patch)
tree075f9dcc996ccc620b362aeb22114c802af0af01 /git-submodule.html
parent975f4dba2f3b9bdb50b16dbad38ac610850e9fc2 (diff)
downloadgit-htmldocs-8c5d59493937c1482fea3e1c3d494aba0abe1005.tar.gz
Autogenerated HTML docs for v2.4.3-413-ga5fe66
Diffstat (limited to 'git-submodule.html')
-rw-r--r--git-submodule.html46
1 files changed, 20 insertions, 26 deletions
diff --git a/git-submodule.html b/git-submodule.html
index 4edf855b3..77d5b8b06 100644
--- a/git-submodule.html
+++ b/git-submodule.html
@@ -767,11 +767,25 @@ git-submodule(1) Manual Page
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>Submodules allow foreign repositories to be embedded within
-a dedicated subdirectory of the source tree, always pointed
-at a particular commit.</p></div>
-<div class="paragraph"><p>They are not to be confused with remotes, which are meant mainly
-for branches of the same project; submodules are meant for
+<div class="paragraph"><p>Inspects, updates and manages submodules.</p></div>
+<div class="paragraph"><p>A submodule allows you to keep another Git repository in a subdirectory
+of your repository. The other repository has its own history, which does not
+interfere with the history of the current repository. This can be used to
+have external dependencies such as third party libraries for example.</p></div>
+<div class="paragraph"><p>When cloning or pulling a repository containing submodules however,
+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.</p></div>
+<div class="paragraph"><p>Submodules are composed from a so-called <code>gitlink</code> tree entry
+in the main repository that refers to a particular commit object
+within the inner repository that is completely separate.
+A record in the <code>.gitmodules</code> (see <a href="gitmodules.html">gitmodules(5)</a>) file at the
+root of the source tree assigns a logical name to the submodule and
+describes the default URL the submodule shall be cloned from.
+The logical name can be used for overriding this URL within your
+local repository configuration (see <em>submodule init</em>).</p></div>
+<div class="paragraph"><p>Submodules are not to be confused with remotes, which are other
+repositories of the same project; submodules are meant for
different projects you would like to make part of your source tree,
while the history of the two projects still stays completely
independent and you cannot modify the contents of the submodule
@@ -782,26 +796,6 @@ add a remote for the other project and use the <em>subtree</em> merge strategy,
instead of treating the other project as a submodule. Directories
that come from both projects can be cloned and checked out as a whole
if you choose to go that route.</p></div>
-<div class="paragraph"><p>Submodules are composed from a so-called <code>gitlink</code> tree entry
-in the main repository that refers to a particular commit object
-within the inner repository that is completely separate.
-A record in the <code>.gitmodules</code> (see <a href="gitmodules.html">gitmodules(5)</a>) file at the
-root of the source tree assigns a logical name to the submodule and
-describes the default URL the submodule shall be cloned from.
-The logical name can be used for overriding this URL within your
-local repository configuration (see <em>submodule init</em>).</p></div>
-<div class="paragraph"><p>This command will manage the tree entries and contents of the
-gitmodules file for you, as well as inspect the status of your
-submodules and update 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 briefly inspect the up-to-date status of your submodules
-using the <em>status</em> subcommand and get a detailed overview of the
-difference between the index and checkouts using the <em>summary</em>
-subcommand.</p></div>
</div>
</div>
<div class="sect1">
@@ -1296,7 +1290,7 @@ for details.</p></div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2015-03-06 15:45:51 PST
+Last updated 2015-06-11 12:36:46 PDT
</div>
</div>
</body>