diff options
author | Junio C Hamano <junio@kernel.org> | 2011-08-08 22:58:15 +0000 |
---|---|---|
committer | Junio C Hamano <junio@kernel.org> | 2011-08-08 22:58:15 +0000 |
commit | e1296e9af0b7e04013cdb44f4cac6d9d456719e7 (patch) | |
tree | 0ccdef89008a70d8f88921d1998a0fd55b0b784a /git-submodule.html | |
parent | 16ebcd0bda2d592eefc14d4450d21986d961b181 (diff) | |
download | git-htmldocs-e1296e9af0b7e04013cdb44f4cac6d9d456719e7.tar.gz |
Autogenerated HTML docs for v1.7.6-433-g1421f
Diffstat (limited to 'git-submodule.html')
-rw-r--r-- | git-submodule.html | 43 |
1 files changed, 30 insertions, 13 deletions
diff --git a/git-submodule.html b/git-submodule.html index 24bf5fd25..9fa984516 100644 --- a/git-submodule.html +++ b/git-submodule.html @@ -421,7 +421,8 @@ git-submodule(1) Manual Page <em>git submodule</em> [--quiet] init [--] [<path>…]
<em>git submodule</em> [--quiet] update [--init] [-N|--no-fetch] [--rebase]
[--reference <repository>] [--merge] [--recursive] [--] [<path>…]
-<em>git submodule</em> [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>…]
+<em>git submodule</em> [--quiet] summary [--cached|--files] [(-n|--summary-limit) <n>]
+ [commit] [--] [<path>…]
<em>git submodule</em> [--quiet] foreach [--recursive] <command>
<em>git submodule</em> [--quiet] sync [--] [<path>…]</div>
<div class="verseblock-attribution">
@@ -517,8 +518,12 @@ status repository and <tt>U</tt> if the submodule has merge conflicts.
This command is the default command for <em>git submodule</em>.
</p>
-<div class="paragraph"><p>If <em>--recursive</em> is specified, this command will recurse into nested
+<div class="paragraph"><p>If <tt>--recursive</tt> is specified, this command will recurse into nested
submodules, and show their status as well.</p></div>
+<div class="paragraph"><p>If you are only interested in changes of the currently initialized
+submodules with respect to the commit recorded in the index or the HEAD,
+<a href="git-status.html">git-status(1)</a> and <a href="git-diff.html">git-diff(1)</a> will provide that information
+too (and can also report changes to a submodule’s work tree).</p></div>
</dd>
<dt class="hdlist1">
init
@@ -543,14 +548,14 @@ update <p>
Update the registered submodules, i.e. clone missing submodules and
checkout the commit specified in the index of the containing repository.
- This will make the submodules HEAD be detached unless <em>--rebase</em> or
- <em>--merge</em> is specified or the key <tt>submodule.$name.update</tt> is set to
+ This will make the submodules HEAD be detached unless <tt>--rebase</tt> or
+ <tt>--merge</tt> is specified or the key <tt>submodule.$name.update</tt> is set to
<tt>rebase</tt> or <tt>merge</tt>.
</p>
<div class="paragraph"><p>If the submodule is not yet initialized, and you just want to use the
setting as stored in .gitmodules, you can automatically initialize the
-submodule with the --init option.</p></div>
-<div class="paragraph"><p>If <em>--recursive</em> is specified, this command will recurse into the
+submodule with the <tt>--init</tt> option.</p></div>
+<div class="paragraph"><p>If <tt>--recursive</tt> is specified, this command will recurse into the
registered submodules, and update any nested submodules within.</p></div>
</dd>
<dt class="hdlist1">
@@ -561,12 +566,14 @@ summary Show commit summary between the given commit (defaults to HEAD) and
working tree/index. For a submodule in question, a series of commits
in the submodule between the given super project commit and the
- index or working tree (switched by --cached) are shown. If the option
- --files is given, show the series of commits in the submodule between
+ index or working tree (switched by <tt>--cached</tt>) are shown. If the option
+ <tt>--files</tt> is given, show the series of commits in the submodule between
the index of the super project and the working tree of the submodule
- (this option doesn’t allow to use the --cached option or to provide an
+ (this option doesn’t allow to use the <tt>--cached</tt> option or to provide an
explicit commit).
</p>
+<div class="paragraph"><p>Using the <tt>--submodule=log</tt> option with <a href="git-diff.html">git-diff(1)</a> will provide that
+information too.</p></div>
</dd>
<dt class="hdlist1">
foreach
@@ -581,9 +588,9 @@ foreach superproject, $sha1 is the commit as recorded in the superproject,
and $toplevel is the absolute path to the top-level of the superproject.
Any submodules defined in the superproject but not checked out are
- ignored by this command. Unless given --quiet, foreach prints the name
+ ignored by this command. Unless given <tt>--quiet</tt>, foreach prints the name
of each submodule before evaluating the command.
- If --recursive is given, submodules are traversed recursively (i.e.
+ If <tt>--recursive</tt> is given, submodules are traversed recursively (i.e.
the given shell command is evaluated in nested submodules as well).
A non-zero return from the command in any submodule causes
the processing to terminate. This can be overridden by adding <em>|| :</em>
@@ -726,6 +733,16 @@ sync </p>
</dd>
<dt class="hdlist1">
+--init
+</dt>
+<dd>
+<p>
+ This option is only valid for the update command.
+ Initialize all submodules for which "git submodule init" has not been
+ called so far before updating.
+</p>
+</dd>
+<dt class="hdlist1">
--reference <repository>
</dt>
<dd>
@@ -735,7 +752,7 @@ sync this option will be passed to the <a href="git-clone.html">git-clone(1)</a> command.
</p>
<div class="paragraph"><p><strong>NOTE</strong>: Do <strong>not</strong> use this option unless you have read the note
-for <a href="git-clone.html">git-clone(1)</a>'s --reference and --shared options carefully.</p></div>
+for <a href="git-clone.html">git-clone(1)</a>'s <tt>--reference</tt> and <tt>--shared</tt> options carefully.</p></div>
</dd>
<dt class="hdlist1">
--recursive
@@ -774,7 +791,7 @@ for details.</p></div> </div>
<div id="footer">
<div id="footer-text">
-Last updated 2011-07-23 00:49:30 UTC
+Last updated 2011-08-08 22:57:51 UTC
</div>
</div>
</body>
|