Skip to content

Commit

Permalink
Autogenerated HTML docs for v2.12.0-244-g62556
Browse files Browse the repository at this point in the history
  • Loading branch information
gitster committed Mar 10, 2017
1 parent cbe0eb2 commit 53eec4d
Show file tree
Hide file tree
Showing 7 changed files with 159 additions and 52 deletions.
65 changes: 65 additions & 0 deletions RelNotes/2.13.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,21 @@ UI, Workflows & Features
but caused renaming of the current branch to something else not to
be logged in a useful way.

* "Cc:" on the trailer part does not have to conform to RFC strictly,
unlike in the e-mail header. "git send-email" has been updated to
ignore anything after '>' when picking addresses, to allow non-address
cruft like " # stable 4.4" after the address.
(merge 9d3343961b jh/send-email-one-cc later to maint).

* When "git submodule init" decides that the submodule in the working
tree is its upstream, it now gives a warning as it is not a very
common setup.
(merge d1b3b81aab sb/submodule-init-url-selection later to maint).

* "git stash save" takes a pathspec so that the local changes can be
stashed away only partially.
(merge 9e140909f6 tg/stash-push later to maint).


Performance, Internal Implementation, Development Support etc.

Expand All @@ -96,6 +111,29 @@ Performance, Internal Implementation, Development Support etc.
* Some warning() messages from "git clean" were updated to show the
errno from failed system calls.

* The "parse_config_key()" API function has been cleaned up.
(merge ad8c7cdadd jk/parse-config-key-cleanup later to maint).

* A test that creates a confusing branch whose name is HEAD has been
corrected not to do so.
(merge f0252ca23c jk/t6300-cleanup later to maint).

* The code that parses header fields in the commit object has been
updated for (micro)performance and code hygiene.
(merge b072504ce1 rs/commit-parsing-optim later to maint).

* An helper function to make it easier to append the result from
real_path() to a strbuf has been added.
(merge 33ad9ddd0b rs/strbuf-add-real-path later to maint).

* Reduce authentication round-trip over HTTP when the server supports
just a single authentication method. This also improves the
behaviour when Git is misconfigured to enable http.emptyAuth
against a server that does not authenticate without a username
(i.e. not using Kerberos etc., which makes http.emptyAuth
pointless).
(merge 40a18fc77c jk/http-auth later to maint).


Also contains various documentation updates and code clean-ups.

Expand Down Expand Up @@ -147,5 +185,32 @@ notes for details).
default) by ignoring a stale "gc.log" file that is too old.
(merge a831c06a2b dt/gc-ignore-old-gc-logs later to maint).

* The code to parse "git -c VAR=VAL cmd" and set configuration
variable for the duration of cmd had two small bugs, which have
been fixed.
(merge 1274a155af jc/config-case-cmdline-take-2 later to maint).

* user.email that consists of only cruft chars should consistently
error out, but didn't.
(merge 94425552f3 jk/ident-empty later to maint).

* "git upload-pack", which is a counter-part of "git fetch", did not
report a request for a ref that was not advertised as invalid.
This is generally not a problem (because "git fetch" will stop
before making such a request), but is the right thing to do.
(merge bdb31eada7 jt/upload-pack-error-report later to maint).

* A leak in a codepath to read from a packed object in (rare) cases
has been plugged.
(merge 886ddf4777 rs/sha1-file-plug-fallback-base-leak later to maint).

* When a redirected http transport gets an error during the
redirected request, we ignored the error we got from the server,
and ended up giving a not-so-useful error message.
(merge 8e27391a5f jt/http-base-url-update-upon-redirect later to maint).

* Other minor doc, test and build updates and code cleanups.
(merge 2cfa83574c mm/two-more-xstrfmt later to maint).
(merge b803ae4427 ps/docs-diffcore later to maint).
(merge bcd886d897 ew/markdown-url-in-readme later to maint).
(merge b2d593a779 rj/remove-unused-mktemp later to maint).
27 changes: 20 additions & 7 deletions git-stash.html
Original file line number Diff line number Diff line change
Expand Up @@ -753,8 +753,11 @@ <h2 id="_synopsis">SYNOPSIS</h2>
<em>git stash</em> drop [-q|--quiet] [&lt;stash&gt;]
<em>git stash</em> ( pop | apply ) [--index] [-q|--quiet] [&lt;stash&gt;]
<em>git stash</em> branch &lt;branchname&gt; [&lt;stash&gt;]
<em>git stash</em> [save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
[-u|--include-untracked] [-a|--all] [&lt;message&gt;]]
<em>git stash</em> save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
[-u|--include-untracked] [-a|--all] [&lt;message&gt;]
<em>git stash</em> [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
[-u|--include-untracked] [-a|--all] [-m|--message &lt;message&gt;]]
[--] [&lt;pathspec&gt;&#8230;]]
<em>git stash</em> clear
<em>git stash</em> create [&lt;message&gt;]
<em>git stash</em> store [-m|--message &lt;message&gt;] [-q|--quiet] &lt;commit&gt;</pre>
Expand Down Expand Up @@ -791,16 +794,26 @@ <h2 id="_options">OPTIONS</h2>
<dt class="hdlist1">
save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [&lt;message&gt;]
</dt>
<dt class="hdlist1">
push [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message &lt;message&gt;] [--] [&lt;pathspec&gt;&#8230;]
</dt>
<dd>
<p>
Save your local modifications to a new <em>stash</em> and roll them
back to HEAD (in the working tree and in the index).
The &lt;message&gt; part is optional and gives
the description along with the stashed state. For quickly making
a snapshot, you can omit <em>both</em> "save" and &lt;message&gt;, but giving
only &lt;message&gt; does not trigger this action to prevent a misspelled
subcommand from making an unwanted stash.
the description along with the stashed state.
</p>
<div class="paragraph"><p>For quickly making a snapshot, you can omit "push". In this mode,
non-option arguments are not allowed to prevent a misspelled
subcommand from making an unwanted stash. The two exceptions to this
are <code>stash -p</code> which acts as alias for <code>stash push -p</code> and pathspecs,
which are allowed after a double hyphen <code>--</code> for disambiguation.</p></div>
<div class="paragraph"><p>When pathspec is given to <em>git stash push</em>, the new stash records the
modified states only for the files that match the pathspec. The index
entries and working tree files are then rolled back to the state in
HEAD only for these files, too, leaving files that do not match the
pathspec intact.</p></div>
<div class="paragraph"><p>If the <code>--keep-index</code> option is used, all changes already added to the
index are left intact.</p></div>
<div class="paragraph"><p>If the <code>--include-untracked</code> option is used, all untracked files are also
Expand Down Expand Up @@ -1085,7 +1098,7 @@ <h2 id="_git">GIT</h2>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2017-02-15 15:17:51 PST
Last updated 2017-03-10 15:02:29 PST
</div>
</div>
</body>
Expand Down
25 changes: 19 additions & 6 deletions git-stash.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,11 @@ SYNOPSIS
'git stash' drop [-q|--quiet] [<stash>]
'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
'git stash' branch <branchname> [<stash>]
'git stash' [save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
[-u|--include-untracked] [-a|--all] [<message>]]
'git stash' save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
[-u|--include-untracked] [-a|--all] [<message>]
'git stash' [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
[-u|--include-untracked] [-a|--all] [-m|--message <message>]]
[--] [<pathspec>...]]
'git stash' clear
'git stash' create [<message>]
'git stash' store [-m|--message <message>] [-q|--quiet] <commit>
Expand Down Expand Up @@ -46,14 +49,24 @@ OPTIONS
-------

save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
push [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message <message>] [--] [<pathspec>...]::

Save your local modifications to a new 'stash' and roll them
back to HEAD (in the working tree and in the index).
The <message> part is optional and gives
the description along with the stashed state. For quickly making
a snapshot, you can omit _both_ "save" and <message>, but giving
only <message> does not trigger this action to prevent a misspelled
subcommand from making an unwanted stash.
the description along with the stashed state.
+
For quickly making a snapshot, you can omit "push". In this mode,
non-option arguments are not allowed to prevent a misspelled
subcommand from making an unwanted stash. The two exceptions to this
are `stash -p` which acts as alias for `stash push -p` and pathspecs,
which are allowed after a double hyphen `--` for disambiguation.
+
When pathspec is given to 'git stash push', the new stash records the
modified states only for the files that match the pathspec. The index
entries and working tree files are then rolled back to the state in
HEAD only for these files, too, leaving files that do not match the
pathspec intact.
+
If the `--keep-index` option is used, all changes already added to the
index are left intact.
Expand Down
38 changes: 22 additions & 16 deletions git-submodule.html
Original file line number Diff line number Diff line change
Expand Up @@ -817,13 +817,16 @@ <h2 id="_commands">COMMANDS</h2>
configuration entries unless <code>--name</code> is used to specify a logical name.</p></div>
<div class="paragraph"><p>&lt;repository&gt; is the URL of the new submodule&#8217;s origin repository.
This may be either an absolute URL, or (if it begins with ./
or ../), the location relative to the superproject&#8217;s origin
or ../), the location relative to the superproject&#8217;s default remote
repository (Please note that to specify a repository <em>foo.git</em>
which is located right next to a superproject <em>bar.git</em>, you&#8217;ll
have to use <em>../foo.git</em> instead of <em>./foo.git</em> - as one might expect
when following the rules for relative URLs - because the evaluation
of relative URLs in Git is identical to that of relative directories).
If the superproject doesn&#8217;t have an origin configured
of relative URLs in Git is identical to that of relative directories).</p></div>
<div class="paragraph"><p>The default remote is the remote of the remote tracking branch
of the current branch. If no such remote tracking branch exists or
the HEAD is detached, "origin" is assumed to be the default remote.
If the superproject doesn&#8217;t have a default remote configured
the superproject is its own authoritative upstream and the current
working directory is used instead.</p></div>
<div class="paragraph"><p>&lt;path&gt; is the relative location for the cloned submodule to
Expand Down Expand Up @@ -867,19 +870,22 @@ <h2 id="_commands">COMMANDS</h2>
<dd>
<p>
Initialize the submodules recorded in the index (which were
added and committed elsewhere) by copying submodule
names and urls from .gitmodules to .git/config.
Optional &lt;path&gt; arguments limit which submodules will be initialized.
It will also copy the value of <code>submodule.$name.update</code> into
.git/config.
The key used in .git/config is <code>submodule.$name.url</code>.
This command does not alter existing information in .git/config.
You can then customize the submodule clone URLs in .git/config
for your local setup and proceed to <code>git submodule update</code>;
you can also just use <code>git submodule update --init</code> without
the explicit <em>init</em> step if you do not intend to customize
any submodule locations.
added and committed elsewhere) by setting <code>submodule.$name.url</code>
in .git/config. It uses the same setting from .gitmodules as
a template. If the URL is relative, it will be resolved using
the default remote. If there is no default remote, the current
repository will be assumed to be upstream.
</p>
<div class="paragraph"><p>Optional &lt;path&gt; arguments limit which submodules will be initialized.
If no path is specified, all submodules are initialized.</p></div>
<div class="paragraph"><p>When present, it will also copy the value of <code>submodule.$name.update</code>.
This command does not alter existing information in .git/config.
You can then customize the submodule clone URLs in .git/config
for your local setup and proceed to <code>git submodule update</code>;
you can also just use <code>git submodule update --init</code> without
the explicit <em>init</em> step if you do not intend to customize
any submodule locations.</p></div>
<div class="paragraph"><p>See the add subcommand for the defintion of default remote.</p></div>
</dd>
<dt class="hdlist1">
deinit [-f|--force] (--all|[--] &lt;path&gt;&#8230;)
Expand Down Expand Up @@ -1352,7 +1358,7 @@ <h2 id="_git">GIT</h2>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2017-02-15 15:17:51 PST
Last updated 2017-03-10 15:02:29 PST
</div>
</div>
</body>
Expand Down
38 changes: 24 additions & 14 deletions git-submodule.txt
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,17 @@ configuration entries unless `--name` is used to specify a logical name.
+
<repository> is the URL of the new submodule's origin repository.
This may be either an absolute URL, or (if it begins with ./
or ../), the location relative to the superproject's origin
or ../), the location relative to the superproject's default remote
repository (Please note that to specify a repository 'foo.git'
which is located right next to a superproject 'bar.git', you'll
have to use '../foo.git' instead of './foo.git' - as one might expect
when following the rules for relative URLs - because the evaluation
of relative URLs in Git is identical to that of relative directories).
If the superproject doesn't have an origin configured
+
The default remote is the remote of the remote tracking branch
of the current branch. If no such remote tracking branch exists or
the HEAD is detached, "origin" is assumed to be the default remote.
If the superproject doesn't have a default remote configured
the superproject is its own authoritative upstream and the current
working directory is used instead.
+
Expand Down Expand Up @@ -118,18 +122,24 @@ too (and can also report changes to a submodule's work tree).

init [--] [<path>...]::
Initialize the submodules recorded in the index (which were
added and committed elsewhere) by copying submodule
names and urls from .gitmodules to .git/config.
Optional <path> arguments limit which submodules will be initialized.
It will also copy the value of `submodule.$name.update` into
.git/config.
The key used in .git/config is `submodule.$name.url`.
This command does not alter existing information in .git/config.
You can then customize the submodule clone URLs in .git/config
for your local setup and proceed to `git submodule update`;
you can also just use `git submodule update --init` without
the explicit 'init' step if you do not intend to customize
any submodule locations.
added and committed elsewhere) by setting `submodule.$name.url`
in .git/config. It uses the same setting from .gitmodules as
a template. If the URL is relative, it will be resolved using
the default remote. If there is no default remote, the current
repository will be assumed to be upstream.
+
Optional <path> arguments limit which submodules will be initialized.
If no path is specified, all submodules are initialized.
+
When present, it will also copy the value of `submodule.$name.update`.
This command does not alter existing information in .git/config.
You can then customize the submodule clone URLs in .git/config
for your local setup and proceed to `git submodule update`;
you can also just use `git submodule update --init` without
the explicit 'init' step if you do not intend to customize
any submodule locations.
+
See the add subcommand for the defintion of default remote.

deinit [-f|--force] (--all|[--] <path>...)::
Unregister the given submodules, i.e. remove the whole
Expand Down
8 changes: 4 additions & 4 deletions gitdiffcore.html
Original file line number Diff line number Diff line change
Expand Up @@ -854,7 +854,7 @@ <h2 id="_the_chain_of_operation">The chain of operation</h2>
</div>
</div>
<div class="sect1">
<h2 id="_diffcore_break_for_splitting_up_complete_rewrites">diffcore-break: For Splitting Up "Complete Rewrites"</h2>
<h2 id="_diffcore_break_for_splitting_up_complete_rewrites">diffcore-break: For Splitting Up Complete Rewrites</h2>
<div class="sectionbody">
<div class="paragraph"><p>The second transformation in the chain is diffcore-break, and is
controlled by the -B option to the <em>git diff-&#42;</em> commands. This is
Expand Down Expand Up @@ -887,7 +887,7 @@ <h2 id="_diffcore_break_for_splitting_up_complete_rewrites">diffcore-break: For
</div>
</div>
<div class="sect1">
<h2 id="_diffcore_rename_for_detection_renames_and_copies">diffcore-rename: For Detection Renames and Copies</h2>
<h2 id="_diffcore_rename_for_detecting_renames_and_copies">diffcore-rename: For Detecting Renames and Copies</h2>
<div class="sectionbody">
<div class="paragraph"><p>This transformation is used to detect renames and copies, and is
controlled by the -M option (to detect renames) and the -C option
Expand Down Expand Up @@ -940,7 +940,7 @@ <h2 id="_diffcore_rename_for_detection_renames_and_copies">diffcore-rename: For
</div>
</div>
<div class="sect1">
<h2 id="_diffcore_merge_broken_for_putting_complete_rewrites_back_together">diffcore-merge-broken: For Putting "Complete Rewrites" Back Together</h2>
<h2 id="_diffcore_merge_broken_for_putting_complete_rewrites_back_together">diffcore-merge-broken: For Putting Complete Rewrites Back Together</h2>
<div class="sectionbody">
<div class="paragraph"><p>This transformation is used to merge filepairs broken by
diffcore-break, and not transformed into rename/copy by
Expand Down Expand Up @@ -1062,7 +1062,7 @@ <h2 id="_git">GIT</h2>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2017-02-15 15:17:51 PST
Last updated 2017-03-10 15:02:29 PST
</div>
</div>
</body>
Expand Down
10 changes: 5 additions & 5 deletions gitdiffcore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ format sections of the manual for 'git diff-{asterisk}' commands) or
diff-patch format.


diffcore-break: For Splitting Up "Complete Rewrites"
----------------------------------------------------
diffcore-break: For Splitting Up Complete Rewrites
--------------------------------------------------

The second transformation in the chain is diffcore-break, and is
controlled by the -B option to the 'git diff-{asterisk}' commands. This is
Expand Down Expand Up @@ -119,7 +119,7 @@ the original is used), and can be customized by giving a number
after "-B" option (e.g. "-B75" to tell it to use 75%).


diffcore-rename: For Detection Renames and Copies
diffcore-rename: For Detecting Renames and Copies
-------------------------------------------------

This transformation is used to detect renames and copies, and is
Expand Down Expand Up @@ -177,8 +177,8 @@ the expense of making it slower. Without `--find-copies-harder`,
copied happened to have been modified in the same changeset.


diffcore-merge-broken: For Putting "Complete Rewrites" Back Together
--------------------------------------------------------------------
diffcore-merge-broken: For Putting Complete Rewrites Back Together
------------------------------------------------------------------

This transformation is used to merge filepairs broken by
diffcore-break, and not transformed into rename/copy by
Expand Down

0 comments on commit 53eec4d

Please sign in to comment.