Skip to content

Commit

Permalink
Autogenerated HTML docs for v1.9.1-445-g125d8e
Browse files Browse the repository at this point in the history
  • Loading branch information
gitster committed Apr 2, 2014
1 parent 52b6ba3 commit 90acbd7
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 64 deletions.
5 changes: 0 additions & 5 deletions RelNotes/2.0.0.txt
Expand Up @@ -126,11 +126,6 @@ UI, Workflows & Features
fully for paths the index knows about but the tree-ish the command
resets to does not (these paths are kept as intend-to-add entries).

* Newly cloned submodule repositories by "git submodule update",
when the "checkout" update mode is used, will be on a local
branch instead of on a detached HEAD, just like submodules added
with "git submodule add".


Performance, Internal Implementation, etc.

Expand Down
34 changes: 9 additions & 25 deletions git-submodule.html
Expand Up @@ -756,7 +756,7 @@ <h2 id="_synopsis">SYNOPSIS</h2>
<em>git submodule</em> [--quiet] init [--] [&lt;path&gt;&#8230;]
<em>git submodule</em> [--quiet] deinit [-f|--force] [--] &lt;path&gt;&#8230;
<em>git submodule</em> [--quiet] update [--init] [--remote] [-N|--no-fetch]
[-f|--force] [--checkout|--rebase|--merge] [--reference &lt;repository&gt;]
[-f|--force] [--rebase|--merge] [--reference &lt;repository&gt;]
[--depth &lt;depth&gt;] [--recursive] [--] [&lt;path&gt;&#8230;]
<em>git submodule</em> [--quiet] summary [--cached|--files] [(-n|--summary-limit) &lt;n&gt;]
[commit] [--] [&lt;path&gt;&#8230;]
Expand Down Expand Up @@ -915,30 +915,14 @@ <h2 id="_commands">COMMANDS</h2>
<dd>
<p>
Update the registered submodules, i.e. clone missing submodules and
checkout the commit specified in the index of the containing
repository. The update mode defaults to <tt>checkout</tt>, but can be
configured with the <tt>submodule.&lt;name&gt;.update</tt> setting or the
<tt>--rebase</tt>, <tt>--merge</tt>, or <tt>--checkout</tt> options.
checkout the commit specified in the index of the containing repository.
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>, <tt>merge</tt> or <tt>none</tt>. <tt>none</tt> can be overridden by specifying
<tt>--checkout</tt>. Setting the key <tt>submodule.$name.update</tt> to <tt>!command</tt>
will cause <tt>command</tt> to be run. <tt>command</tt> can be any arbitrary shell
command that takes a single argument, namely the sha1 to update to.
</p>
<div class="paragraph"><p>For updates that clone missing submodules, checkout-mode updates will
create submodules with detached HEADs; all other modes will create
submodules with a local branch named after <tt>submodule.&lt;name&gt;.branch</tt>.</p></div>
<div class="paragraph"><p>For updates that do not clone missing submodules, the submodule&#8217;s HEAD
is only touched when the remote reference does not match the
submodule&#8217;s HEAD (for none-mode updates, the submodule is never
touched). The remote reference is usually the gitlinked commit from
the superproject&#8217;s tree, but with <tt>--remote</tt> it is the upstream
subproject&#8217;s <tt>submodule.&lt;name&gt;.branch</tt>. This remote reference is
integrated with the submodule&#8217;s HEAD using the specified update mode.
For checkout-mode updates, that will result in a detached HEAD. For
rebase- and merge-mode updates, the commit referenced by the
submodule&#8217;s HEAD may change, but the symbolic reference will remain
unchanged (i.e. checked-out branches will still be checked-out
branches, and detached HEADs will still be detached HEADs). If none
of the builtin modes fit your needs, set <tt>submodule.&lt;name&gt;.update</tt> to
<tt>!command</tt> to configure a custom integration command. <tt>command</tt> can
be any arbitrary shell command that takes a single argument, namely
the sha1 to update to.</p></div>
<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 <tt>--init</tt> option.</p></div>
Expand Down Expand Up @@ -1264,7 +1248,7 @@ <h2 id="_git">GIT</h2>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2014-03-31 17:26:22 PDT
Last updated 2014-04-02 15:40:12 PDT
</div>
</div>
</body>
Expand Down
34 changes: 8 additions & 26 deletions git-submodule.txt
Expand Up @@ -15,7 +15,7 @@ SYNOPSIS
'git submodule' [--quiet] init [--] [<path>...]
'git submodule' [--quiet] deinit [-f|--force] [--] <path>...
'git submodule' [--quiet] update [--init] [--remote] [-N|--no-fetch]
[-f|--force] [--checkout|--rebase|--merge] [--reference <repository>]
[-f|--force] [--rebase|--merge] [--reference <repository>]
[--depth <depth>] [--recursive] [--] [<path>...]
'git submodule' [--quiet] summary [--cached|--files] [(-n|--summary-limit) <n>]
[commit] [--] [<path>...]
Expand Down Expand Up @@ -155,31 +155,13 @@ it contains local modifications.

update::
Update the registered submodules, i.e. clone missing submodules and
checkout the commit specified in the index of the containing
repository. The update mode defaults to `checkout`, but can be
configured with the `submodule.<name>.update` setting or the
`--rebase`, `--merge`, or `--checkout` options.
+
For updates that clone missing submodules, checkout-mode updates will
create submodules with detached HEADs; all other modes will create
submodules with a local branch named after `submodule.<name>.branch`.
+
For updates that do not clone missing submodules, the submodule's HEAD
is only touched when the remote reference does not match the
submodule's HEAD (for none-mode updates, the submodule is never
touched). The remote reference is usually the gitlinked commit from
the superproject's tree, but with `--remote` it is the upstream
subproject's `submodule.<name>.branch`. This remote reference is
integrated with the submodule's HEAD using the specified update mode.
For checkout-mode updates, that will result in a detached HEAD. For
rebase- and merge-mode updates, the commit referenced by the
submodule's HEAD may change, but the symbolic reference will remain
unchanged (i.e. checked-out branches will still be checked-out
branches, and detached HEADs will still be detached HEADs). If none
of the builtin modes fit your needs, set `submodule.<name>.update` to
`!command` to configure a custom integration command. `command` can
be any arbitrary shell command that takes a single argument, namely
the sha1 to update to.
checkout the commit specified in the index of the containing repository.
This will make the submodules HEAD be detached unless `--rebase` or
`--merge` is specified or the key `submodule.$name.update` is set to
`rebase`, `merge` or `none`. `none` can be overridden by specifying
`--checkout`. Setting the key `submodule.$name.update` to `!command`
will cause `command` to be run. `command` can be any arbitrary shell
command that takes a single argument, namely the sha1 to update to.
+
If the submodule is not yet initialized, and you just want to use the
setting as stored in .gitmodules, you can automatically initialize the
Expand Down
5 changes: 1 addition & 4 deletions gitmodules.html
Expand Up @@ -819,9 +819,6 @@ <h2 id="_description">DESCRIPTION</h2>
If the option is not specified, it defaults to <em>master</em>. See the
<tt>--remote</tt> documentation in <a href="git-submodule.html">git-submodule(1)</a> for details.
</p>
<div class="paragraph"><p>This branch name is also used for the local branch created by
non-checkout cloning updates. See the <tt>update</tt> documentation in
<a href="git-submodule.html">git-submodule(1)</a> for details.</p></div>
</dd>
<dt class="hdlist1">
submodule.&lt;name&gt;.fetchRecurseSubmodules
Expand Down Expand Up @@ -897,7 +894,7 @@ <h2 id="_git">GIT</h2>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2014-02-27 15:06:29 PST
Last updated 2014-04-02 15:40:12 PDT
</div>
</div>
</body>
Expand Down
4 changes: 0 additions & 4 deletions gitmodules.txt
Expand Up @@ -55,10 +55,6 @@ submodule.<name>.branch::
A remote branch name for tracking updates in the upstream submodule.
If the option is not specified, it defaults to 'master'. See the
`--remote` documentation in linkgit:git-submodule[1] for details.
+
This branch name is also used for the local branch created by
non-checkout cloning updates. See the `update` documentation in
linkgit:git-submodule[1] for details.

submodule.<name>.fetchRecurseSubmodules::
This option can be used to control recursive fetching of this
Expand Down

0 comments on commit 90acbd7

Please sign in to comment.