summaryrefslogtreecommitdiffstats
path: root/git-submodule.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2017-07-12 16:01:13 -0700
committerJunio C Hamano <gitster@pobox.com>2017-07-12 16:01:13 -0700
commit387ce23faf999558814034627e2b19817cec39a0 (patch)
treeba96103624ffa945473bf1b40fce7966f726e78c /git-submodule.html
parenta1de73bc2c02e2d0de12238731fbd5bb3b45aedb (diff)
downloadgit-htmldocs-387ce23faf999558814034627e2b19817cec39a0.tar.gz
Autogenerated HTML docs for v2.13.3-649-g80145
Diffstat (limited to 'git-submodule.html')
-rw-r--r--git-submodule.html44
1 files changed, 12 insertions, 32 deletions
diff --git a/git-submodule.html b/git-submodule.html
index f4a26c74e..488f9e4dc 100644
--- a/git-submodule.html
+++ b/git-submodule.html
@@ -765,34 +765,7 @@ git-submodule(1) Manual Page
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<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
-from within the main project.
-If you want to merge the project histories and want to treat the
-aggregated whole as a single project from then on, you may want to
-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>For more information about submodules, see <a href="gitsubmodules.html">gitsubmodules(7)</a>.</p></div>
</div>
</div>
<div class="sect1">
@@ -893,14 +866,15 @@ deinit [-f|--force] (--all|[--] &lt;path&gt;&#8230;)
tree. Further calls to <code>git submodule update</code>, <code>git submodule foreach</code>
and <code>git submodule sync</code> will skip any unregistered submodules until
they are initialized again, so use this command if you don&#8217;t want to
- have a local checkout of the submodule in your working tree anymore. If
- you really want to remove a submodule from the repository and commit
- that use <a href="git-rm.html">git-rm(1)</a> instead.
+ have a local checkout of the submodule in your working tree anymore.
</p>
<div class="paragraph"><p>When the command is run without pathspec, it errors out,
instead of deinit-ing everything, to prevent mistakes.</p></div>
<div class="paragraph"><p>If <code>--force</code> is specified, the submodule&#8217;s working tree will
be removed even if it contains local modifications.</p></div>
+<div class="paragraph"><p>If you really want to remove a submodule from the repository and commit
+that use <a href="git-rm.html">git-rm(1)</a> instead. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for removal
+options.</p></div>
</dd>
<dt class="hdlist1">
update [--init] [--remote] [-N|--no-fetch] [--[no-]recommend-shallow] [-f|--force] [--checkout|--rebase|--merge] [--reference &lt;repository&gt;] [--depth &lt;depth&gt;] [--recursive] [--jobs &lt;n&gt;] [--] [&lt;path&gt;&#8230;]
@@ -1345,6 +1319,12 @@ for details.</p></div>
</div>
</div>
<div class="sect1">
+<h2 id="_see_also">SEE ALSO</h2>
+<div class="sectionbody">
+<div class="paragraph"><p><a href="gitsubmodules.html">gitsubmodules(7)</a>, <a href="gitmodules.html">gitmodules(5)</a>.</p></div>
+</div>
+</div>
+<div class="sect1">
<h2 id="_git">GIT</h2>
<div class="sectionbody">
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
@@ -1354,7 +1334,7 @@ for details.</p></div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-06-30 14:49:23 PDT
+Last updated 2017-07-12 16:01:04 PDT
</div>
</div>
</body>