Skip to content

Commit

Permalink
Autogenerated HTML docs for v2.3.2-209-gd67f9
Browse files Browse the repository at this point in the history
  • Loading branch information
gitster committed Mar 6, 2015
1 parent 7f1bc9d commit 6bf68cf
Show file tree
Hide file tree
Showing 12 changed files with 186 additions and 82 deletions.
11 changes: 11 additions & 0 deletions RelNotes/2.3.2.txt
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,15 @@ Fixes since v2.3.1
heuristics. The tests and their prerequisites have been updated to
check what they really require.

* The configuration variable 'mailinfo.scissors' was hard to
discover in the documentation.

* Correct a breakage to git-svn around v2.2 era that triggers
premature closing of FileHandle.

* Even though we officially haven't dropped Perl 5.8 support, the
Getopt::Long package that came with it does not support "--no-"
prefix to negate a boolean option; manually add support to help
people with older Getopt::Long package.

Also contains typofixes, documentation updates and trivial code clean-ups.
14 changes: 9 additions & 5 deletions config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2417,12 +2417,16 @@ status.submodulesummary::

submodule.<name>.path::
submodule.<name>.url::
The path within this project and URL for a submodule. These
variables are initially populated by 'git submodule init'. See
linkgit:git-submodule[1] and linkgit:gitmodules[5] for
details.

submodule.<name>.update::
The path within this project, URL, and the updating strategy
for a submodule. These variables are initially populated
by 'git submodule init'; edit them to override the
URL and other values found in the `.gitmodules` file. See
linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
The default update procedure for a submodule. This variable
is populated by `git submodule init` from the
linkgit:gitmodules[5] file. See description of 'update'
command in linkgit:git-submodule[1].

submodule.<name>.branch::
The remote branch name for a submodule, used by `git submodule
Expand Down
10 changes: 7 additions & 3 deletions git-clean.html
Original file line number Diff line number Diff line change
Expand Up @@ -789,8 +789,12 @@ <h2 id="_options">OPTIONS</h2>
<dd>
<p>
If the Git configuration variable clean.requireForce is not set
to false, <em>git clean</em> will refuse to run unless given -f, -n or
-i.
to false, <em>git clean</em> will refuse to delete files or directories
unless given -f, -n or -i. Git will refuse to delete directories
with .git sub directory or file unless a second -f
is given. This affects also git submodules where the storage area
of the removed submodule under .git/modules/ is not removed until
-f is given twice.
</p>
</dd>
<dt class="hdlist1">
Expand Down Expand Up @@ -968,7 +972,7 @@ <h2 id="_git">GIT</h2>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2014-11-04 14:37:41 PST
Last updated 2015-03-06 15:45:51 PST
</div>
</div>
</body>
Expand Down
8 changes: 6 additions & 2 deletions git-clean.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,12 @@ OPTIONS
-f::
--force::
If the Git configuration variable clean.requireForce is not set
to false, 'git clean' will refuse to run unless given -f, -n or
-i.
to false, 'git clean' will refuse to delete files or directories
unless given -f, -n or -i. Git will refuse to delete directories
with .git sub directory or file unless a second -f
is given. This affects also git submodules where the storage area
of the removed submodule under .git/modules/ is not removed until
-f is given twice.

-i::
--interactive::
Expand Down
17 changes: 12 additions & 5 deletions git-config.html
Original file line number Diff line number Diff line change
Expand Up @@ -6173,16 +6173,23 @@ <h3 id="_variables">Variables</h3>
<dt class="hdlist1">
submodule.&lt;name&gt;.url
</dt>
<dd>
<p>
The path within this project and URL for a submodule. These
variables are initially populated by <em>git submodule init</em>. See
<a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for
details.
</p>
</dd>
<dt class="hdlist1">
submodule.&lt;name&gt;.update
</dt>
<dd>
<p>
The path within this project, URL, and the updating strategy
for a submodule. These variables are initially populated
by <em>git submodule init</em>; edit them to override the
URL and other values found in the <code>.gitmodules</code> file. See
<a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
The default update procedure for a submodule. This variable
is populated by <code>git submodule init</code> from the
<a href="gitmodules.html">gitmodules(5)</a> file. See description of <em>update</em>
command in <a href="git-submodule.html">git-submodule(1)</a>.
</p>
</dd>
<dt class="hdlist1">
Expand Down
4 changes: 3 additions & 1 deletion git-remote.html
Original file line number Diff line number Diff line change
Expand Up @@ -810,6 +810,8 @@ <h2 id="_commands">COMMANDS</h2>
remote repository.</p></div>
<div class="paragraph"><p>With <code>--no-tags</code> option, <code>git fetch &lt;name&gt;</code> does not import tags from
the remote repository.</p></div>
<div class="paragraph"><p>By default, only tags on fetched branches are imported
(see <a href="git-fetch.html">git-fetch(1)</a>).</p></div>
<div class="paragraph"><p>With <code>-t &lt;branch&gt;</code> option, instead of the default glob
refspec for the remote to track all branches under
the <code>refs/remotes/&lt;name&gt;/</code> namespace, a refspec to track only <code>&lt;branch&gt;</code>
Expand Down Expand Up @@ -1026,7 +1028,7 @@ <h2 id="_git">GIT</h2>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2015-02-18 14:33:44 PST
Last updated 2015-03-06 15:45:51 PST
</div>
</div>
</body>
Expand Down
3 changes: 3 additions & 0 deletions git-remote.txt
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ remote repository.
With `--no-tags` option, `git fetch <name>` does not import tags from
the remote repository.
+
By default, only tags on fetched branches are imported
(see linkgit:git-fetch[1]).
+
With `-t <branch>` option, instead of the default glob
refspec for the remote to track all branches under
the `refs/remotes/<name>/` namespace, a refspec to track only `<branch>`
Expand Down
86 changes: 68 additions & 18 deletions git-submodule.html
Original file line number Diff line number Diff line change
Expand Up @@ -911,25 +911,73 @@ <h2 id="_commands">COMMANDS</h2>
update
</dt>
<dd>
<div class="openblock">
<div class="content">
<div class="paragraph"><p>Update the registered submodules to match what the superproject
expects by cloning missing submodules and updating the working tree of
the submodules. The "updating" can be done in several ways depending
on command line options and the value of <code>submodule.&lt;name&gt;.update</code>
configuration variable. Supported update procedures are:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
checkout
</dt>
<dd>
<p>
the commit recorded in the superproject will be
checked out in the submodule on a detached HEAD. This is
done when <code>--checkout</code> option is given, or no option is
given, and <code>submodule.&lt;name&gt;.update</code> is unset, or if it is
set to <em>checkout</em>.
</p>
<div class="paragraph"><p>If <code>--force</code> is specified, the submodule will be checked out (using
<code>git checkout --force</code> if appropriate), even if the commit specified
in the index of the containing repository already matches the commit
checked out in the submodule.</p></div>
</dd>
<dt class="hdlist1">
rebase
</dt>
<dd>
<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 <code>--rebase</code> or
<code>--merge</code> is specified or the key <code>submodule.$name.update</code> is set to
<code>rebase</code>, <code>merge</code> or <code>none</code>. <code>none</code> can be overridden by specifying
<code>--checkout</code>. Setting the key <code>submodule.$name.update</code> to <code>!command</code>
will cause <code>command</code> to be run. <code>command</code> can be any arbitrary shell
command that takes a single argument, namely the sha1 to update to.
the current branch of the submodule will be rebased
onto the commit recorded in the superproject. This is done
when <code>--rebase</code> option is given, or no option is given, and
<code>submodule.&lt;name&gt;.update</code> is set to <em>rebase</em>.
</p>
</dd>
<dt class="hdlist1">
merge
</dt>
<dd>
<p>
the commit recorded in the superproject will be merged
into the current branch in the submodule. This is done
when <code>--merge</code> option is given, or no option is given, and
<code>submodule.&lt;name&gt;.update</code> is set to <em>merge</em>.
</p>
</dd>
<dt class="hdlist1">
custom command
</dt>
<dd>
<p>
arbitrary shell command that takes a single
argument (the sha1 of the commit recorded in the
superproject) is executed. This is done when no option is
given, and <code>submodule.&lt;name&gt;.update</code> has the form of
<em>!command</em>.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>When no option is given and <code>submodule.&lt;name&gt;.update</code> is set to <em>none</em>,
the submodule is not updated.</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 <code>--init</code> option.</p></div>
<div class="paragraph"><p>If <code>--recursive</code> is specified, this command will recurse into the
registered submodules, and update any nested submodules within.</p></div>
<div class="paragraph"><p>If <code>--force</code> is specified, the submodule will be checked out (using
<code>git checkout --force</code> if appropriate), even if the commit specified in the
index of the containing repository already matches the commit checked out in
the submodule.</p></div>
</div></div>
</dd>
<dt class="hdlist1">
summary
Expand Down Expand Up @@ -1031,10 +1079,12 @@ <h2 id="_options">OPTIONS</h2>
When running add, allow adding an otherwise ignored submodule path.
When running deinit the submodule work trees will be removed even if
they contain local changes.
When running update, throw away local changes in submodules when
switching to a different commit; and always run a checkout operation
in the submodule, even if the commit listed in the index of the
containing repository matches the commit checked out in the submodule.
When running update (only effective with the checkout procedure),
throw away local changes in submodules when switching to a
different commit; and always run a checkout operation in the
submodule, even if the commit listed in the index of the
containing repository matches the commit checked out in the
submodule.
</p>
</dd>
<dt class="hdlist1">
Expand Down Expand Up @@ -1126,7 +1176,7 @@ <h2 id="_options">OPTIONS</h2>
Checkout the commit recorded in the superproject on a detached HEAD
in the submodule. This is the default behavior, the main use of
this option is to override <code>submodule.$name.update</code> when set to
<code>merge</code>, <code>rebase</code> or <code>none</code>.
a value other than <code>checkout</code>.
If the key <code>submodule.$name.update</code> is either not explicitly set or
set to <code>checkout</code>, this option is implicit.
</p>
Expand Down Expand Up @@ -1246,7 +1296,7 @@ <h2 id="_git">GIT</h2>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2014-06-26 14:48:22 PDT
Last updated 2015-03-06 15:45:51 PST
</div>
</div>
</body>
Expand Down
66 changes: 46 additions & 20 deletions git-submodule.txt
Original file line number Diff line number Diff line change
Expand Up @@ -154,27 +154,51 @@ If `--force` is specified, the submodule's work tree will be removed even if
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.
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.
+
--
Update the registered submodules to match what the superproject
expects by cloning missing submodules and updating the working tree of
the submodules. The "updating" can be done in several ways depending
on command line options and the value of `submodule.<name>.update`
configuration variable. Supported update procedures are:

checkout;; the commit recorded in the superproject will be
checked out in the submodule on a detached HEAD. This is
done when `--checkout` option is given, or no option is
given, and `submodule.<name>.update` is unset, or if it is
set to 'checkout'.
+
If `--force` is specified, the submodule will be checked out (using
`git checkout --force` if appropriate), even if the commit specified
in the index of the containing repository already matches the commit
checked out in the submodule.

rebase;; the current branch of the submodule will be rebased
onto the commit recorded in the superproject. This is done
when `--rebase` option is given, or no option is given, and
`submodule.<name>.update` is set to 'rebase'.

merge;; the commit recorded in the superproject will be merged
into the current branch in the submodule. This is done
when `--merge` option is given, or no option is given, and
`submodule.<name>.update` is set to 'merge'.

custom command;; arbitrary shell command that takes a single
argument (the sha1 of the commit recorded in the
superproject) is executed. This is done when no option is
given, and `submodule.<name>.update` has the form of
'!command'.

When no option is given and `submodule.<name>.update` is set to 'none',
the submodule is not updated.

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.
+

If `--recursive` is specified, this command will recurse into the
registered submodules, and update any nested submodules within.
+
If `--force` is specified, the submodule will be checked out (using
`git checkout --force` if appropriate), even if the commit specified in the
index of the containing repository already matches the commit checked out in
the submodule.

--
summary::
Show commit summary between the given commit (defaults to HEAD) and
working tree/index. For a submodule in question, a series of commits
Expand Down Expand Up @@ -238,10 +262,12 @@ OPTIONS
When running add, allow adding an otherwise ignored submodule path.
When running deinit the submodule work trees will be removed even if
they contain local changes.
When running update, throw away local changes in submodules when
switching to a different commit; and always run a checkout operation
in the submodule, even if the commit listed in the index of the
containing repository matches the commit checked out in the submodule.
When running update (only effective with the checkout procedure),
throw away local changes in submodules when switching to a
different commit; and always run a checkout operation in the
submodule, even if the commit listed in the index of the
containing repository matches the commit checked out in the
submodule.

--cached::
This option is only valid for status and summary commands. These
Expand Down Expand Up @@ -302,7 +328,7 @@ the submodule itself.
Checkout the commit recorded in the superproject on a detached HEAD
in the submodule. This is the default behavior, the main use of
this option is to override `submodule.$name.update` when set to
`merge`, `rebase` or `none`.
a value other than `checkout`.
If the key `submodule.$name.update` is either not explicitly set or
set to `checkout`, this option is implicit.

Expand Down
3 changes: 2 additions & 1 deletion git.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,10 @@ unreleased) version of Git, that is available from the 'master'
branch of the `git.git` repository.
Documentation for older releases are available here:

* link:v2.3.1/git.html[documentation for release 2.3.1]
* link:v2.3.2/git.html[documentation for release 2.3.2]

* release notes for
link:RelNotes/2.3.2.txt[2.3.2],
link:RelNotes/2.3.1.txt[2.3.1],
link:RelNotes/2.3.0.txt[2.3].

Expand Down
25 changes: 10 additions & 15 deletions gitmodules.html
Original file line number Diff line number Diff line change
Expand Up @@ -792,21 +792,16 @@ <h2 id="_description">DESCRIPTION</h2>
</dt>
<dd>
<p>
Defines what to do when the submodule is updated by the superproject.
If <em>checkout</em> (the default), the new commit specified in the
superproject will be checked out in the submodule on a detached HEAD.
If <em>rebase</em>, the current branch of the submodule will be rebased onto
the commit specified in the superproject. If <em>merge</em>, the commit
specified in the superproject will be merged into the current branch
in the submodule.
If <em>none</em>, the submodule with name <code>$name</code> will not be updated
by default.
Defines the default update procedure for the named submodule,
i.e. how the submodule is updated by "git submodule update"
command in the superproject. This is only used by <code>git
submodule init</code> to initialize the configuration variable of
the same name. Allowed values here are <em>checkout</em>, <em>rebase</em>,
<em>merge</em> or <em>none</em>. See description of <em>update</em> command in
<a href="git-submodule.html">git-submodule(1)</a> for their meaning. Note that the
<em>!command</em> form is intentionally ignored here for security
reasons.
</p>
<div class="literalblock">
<div class="content">
<pre><code>This config option is overridden if 'git submodule update' is given
the '--merge', '--rebase' or '--checkout' options.</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
submodule.&lt;name&gt;.branch
Expand Down Expand Up @@ -894,7 +889,7 @@ <h2 id="_git">GIT</h2>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2014-06-16 14:13:22 PDT
Last updated 2015-03-06 15:45:51 PST
</div>
</div>
</body>
Expand Down
Loading

0 comments on commit 6bf68cf

Please sign in to comment.