Skip to content

Commit c21ab05

Browse files
author
Junio C Hamano
committed
Autogenerated HTML docs for v1.6.5.2-140-g5f809
1 parent 621e123 commit c21ab05

27 files changed

+750
-434
lines changed

‎diff-options.txt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,13 @@ endif::git-format-patch[]
8787
Show only names and status of changed files. See the description
8888
of the `--diff-filter` option on what the status letters mean.
8989

90+
--submodule[=<format>]::
91+
Chose the output format for submodule differences. <format> can be one of
92+
'short' and 'log'. 'short' just shows pairs of commit names, this format
93+
is used when this option is not given. 'log' is the default value for this
94+
option and lists the commits in that commit range like the 'summary'
95+
option of linkgit:git-submodule[1] does.
96+
9097
--color::
9198
Show colored diff.
9299

‎fetch-options.txt‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,13 @@
1-
ifndef::git-pull[]
2-
-q::
3-
--quiet::
4-
Pass --quiet to git-fetch-pack and silence any other internally
5-
used git commands.
6-
7-
-v::
8-
--verbose::
9-
Be verbose.
10-
endif::git-pull[]
11-
121
-a::
132
--append::
143
Append ref names and object names of fetched refs to the
154
existing contents of `.git/FETCH_HEAD`. Without this
165
option old data in `.git/FETCH_HEAD` will be overwritten.
176

18-
--upload-pack <upload-pack>::
19-
When given, and the repository to fetch from is handled
20-
by 'git-fetch-pack', '--exec=<upload-pack>' is passed to
21-
the command to specify non-default path for the command
22-
run on the other end.
7+
--depth=<depth>::
8+
Deepen the history of a 'shallow' repository created by
9+
`git clone` with `--depth=<depth>` option (see linkgit:git-clone[1])
10+
by the specified number of commits.
2311

2412
-f::
2513
--force::
@@ -29,6 +17,10 @@ endif::git-pull[]
2917
fetches is a descendant of `<lbranch>`. This option
3018
overrides that check.
3119

20+
-k::
21+
--keep::
22+
Keep downloaded pack.
23+
3224
ifdef::git-pull[]
3325
--no-tags::
3426
endif::git-pull[]
@@ -49,10 +41,6 @@ endif::git-pull[]
4941
flag lets all tags and their associated objects be
5042
downloaded.
5143

52-
-k::
53-
--keep::
54-
Keep downloaded pack.
55-
5644
-u::
5745
--update-head-ok::
5846
By default 'git-fetch' refuses to update the head which
@@ -62,7 +50,19 @@ endif::git-pull[]
6250
implementing your own Porcelain you are not supposed to
6351
use it.
6452

65-
--depth=<depth>::
66-
Deepen the history of a 'shallow' repository created by
67-
`git clone` with `--depth=<depth>` option (see linkgit:git-clone[1])
68-
by the specified number of commits.
53+
--upload-pack <upload-pack>::
54+
When given, and the repository to fetch from is handled
55+
by 'git-fetch-pack', '--exec=<upload-pack>' is passed to
56+
the command to specify non-default path for the command
57+
run on the other end.
58+
59+
ifndef::git-pull[]
60+
-q::
61+
--quiet::
62+
Pass --quiet to git-fetch-pack and silence any other internally
63+
used git commands.
64+
65+
-v::
66+
--verbose::
67+
Be verbose.
68+
endif::git-pull[]

‎git-bisect.html‎

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ <h2 id="_description">DESCRIPTION</h2>
333333
git bisect bad [&lt;rev&gt;]
334334
git bisect good [&lt;rev&gt;...]
335335
git bisect skip [(&lt;rev&gt;|&lt;range&gt;)...]
336-
git bisect reset [&lt;branch&gt;]
336+
git bisect reset [&lt;commit&gt;]
337337
git bisect visualize
338338
git bisect replay &lt;logfile&gt;
339339
git bisect log
@@ -380,15 +380,24 @@ <h3 id="_basic_bisect_commands_start_bad_good">Basic bisect commands: start, bad
380380
<div class="para"><p>Eventually there will be no more revisions left to bisect, and you
381381
will have been left with the first bad kernel revision in "refs/bisect/bad".</p></div>
382382
<h3 id="_bisect_reset">Bisect reset</h3><div style="clear:left"></div>
383-
<div class="para"><p>To return to the original head after a bisect session, issue the
384-
following command:</p></div>
383+
<div class="para"><p>After a bisect session, to clean up the bisection state and return to
384+
the original HEAD, issue the following command:</p></div>
385385
<div class="listingblock">
386386
<div class="content">
387387
<pre><tt>$ git bisect reset</tt></pre>
388388
</div></div>
389-
<div class="para"><p>This resets the tree to the original branch instead of being on the
390-
bisection commit ("git bisect start" will also do that, as it resets
391-
the bisection state).</p></div>
389+
<div class="para"><p>By default, this will return your tree to the commit that was checked
390+
out before <tt>git bisect start</tt>. (A new <tt>git bisect start</tt> will also do
391+
that, as it cleans up the old bisection state.)</p></div>
392+
<div class="para"><p>With an optional argument, you can return to a different commit
393+
instead:</p></div>
394+
<div class="listingblock">
395+
<div class="content">
396+
<pre><tt>$ git bisect reset &lt;commit&gt;</tt></pre>
397+
</div></div>
398+
<div class="para"><p>For example, <tt>git bisect reset HEAD</tt> will leave you on the current
399+
bisection commit and avoid switching commits at all, while <tt>git bisect
400+
reset bisect/bad</tt> will check out the first bad revision.</p></div>
392401
<h3 id="_bisect_visualize">Bisect visualize</h3><div style="clear:left"></div>
393402
<div class="para"><p>To see the currently remaining suspects in <em>gitk</em>, issue the following
394403
command during the bisection process:</p></div>
@@ -599,7 +608,7 @@ <h2 id="_git">GIT</h2>
599608
</div>
600609
<div id="footer">
601610
<div id="footer-text">
602-
Last updated 2009-07-02 03:16:40 UTC
611+
Last updated 2009-10-31 04:03:02 UTC
603612
</div>
604613
</div>
605614
</body>

‎git-bisect.txt‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ on the subcommand:
2020
git bisect bad [<rev>]
2121
git bisect good [<rev>...]
2222
git bisect skip [(<rev>|<range>)...]
23-
git bisect reset [<branch>]
23+
git bisect reset [<commit>]
2424
git bisect visualize
2525
git bisect replay <logfile>
2626
git bisect log
@@ -81,16 +81,27 @@ will have been left with the first bad kernel revision in "refs/bisect/bad".
8181
Bisect reset
8282
~~~~~~~~~~~~
8383

84-
To return to the original head after a bisect session, issue the
85-
following command:
84+
After a bisect session, to clean up the bisection state and return to
85+
the original HEAD, issue the following command:
8686

8787
------------------------------------------------
8888
$ git bisect reset
8989
------------------------------------------------
9090

91-
This resets the tree to the original branch instead of being on the
92-
bisection commit ("git bisect start" will also do that, as it resets
93-
the bisection state).
91+
By default, this will return your tree to the commit that was checked
92+
out before `git bisect start`. (A new `git bisect start` will also do
93+
that, as it cleans up the old bisection state.)
94+
95+
With an optional argument, you can return to a different commit
96+
instead:
97+
98+
------------------------------------------------
99+
$ git bisect reset <commit>
100+
------------------------------------------------
101+
102+
For example, `git bisect reset HEAD` will leave you on the current
103+
bisection commit and avoid switching commits at all, while `git bisect
104+
reset bisect/bad` will check out the first bad revision.
94105

95106
Bisect visualize
96107
~~~~~~~~~~~~~~~~

‎git-check-ref-format.html‎

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -322,6 +322,7 @@ <h2>SYNOPSIS</h2>
322322
<div class="sectionbody">
323323
<div class="verseblock">
324324
<div class="content"><em>git check-ref-format</em> &lt;refname&gt;
325+
<em>git check-ref-format</em> --print &lt;refname&gt;
325326
<em>git check-ref-format</em> --branch &lt;branchname-shorthand&gt;</div></div>
326327
</div>
327328
<h2 id="_description">DESCRIPTION</h2>
@@ -415,32 +416,46 @@ <h2 id="_description">DESCRIPTION</h2>
415416
</p>
416417
</li>
417418
</ol></div>
419+
<div class="para"><p>With the <tt>--print</tt> option, if <em>refname</em> is acceptable, it prints the
420+
canonicalized name of a hypothetical reference with that name. That is,
421+
it prints <em>refname</em> with any extra <tt>/</tt> characters removed.</p></div>
418422
<div class="para"><p>With the <tt>--branch</tt> option, it expands the &#8220;previous branch syntax&#8221;
419423
<tt>@{-n}</tt>. For example, <tt>@{-1}</tt> is a way to refer the last branch you
420424
were on. This option should be used by porcelains to accept this
421425
syntax anywhere a branch name is expected, so they can act as if you
422426
typed the branch name.</p></div>
423427
</div>
424-
<h2 id="_example">EXAMPLE</h2>
428+
<h2 id="_examples">EXAMPLES</h2>
425429
<div class="sectionbody">
426-
<div class="vlist"><dl>
427-
<dt>
428-
git check-ref-format --branch @{-1}
429-
</dt>
430-
<dd>
430+
<div class="ilist"><ul>
431+
<li>
432+
<p>
433+
Print the name of the previous branch:
434+
</p>
435+
<div class="listingblock">
436+
<div class="content">
437+
<pre><tt>$ git check-ref-format --branch @{-1}</tt></pre>
438+
</div></div>
439+
</li>
440+
<li>
431441
<p>
432-
Print the name of the previous branch.
442+
Determine the reference name to use for a new branch:
433443
</p>
434-
</dd>
435-
</dl></div>
444+
<div class="listingblock">
445+
<div class="content">
446+
<pre><tt>$ ref=$(git check-ref-format --print "refs/heads/$newbranch") ||
447+
die "we do not like '$newbranch' as a branch name."</tt></pre>
448+
</div></div>
449+
</li>
450+
</ul></div>
436451
</div>
437452
<h2 id="_git">GIT</h2>
438453
<div class="sectionbody">
439454
<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
440455
</div>
441456
<div id="footer">
442457
<div id="footer-text">
443-
Last updated 2009-10-19 08:04:09 UTC
458+
Last updated 2009-10-31 04:03:02 UTC
444459
</div>
445460
</div>
446461
</body>

‎git-check-ref-format.txt‎

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ SYNOPSIS
99
--------
1010
[verse]
1111
'git check-ref-format' <refname>
12+
'git check-ref-format' --print <refname>
1213
'git check-ref-format' --branch <branchname-shorthand>
1314

1415
DESCRIPTION
@@ -63,19 +64,31 @@ reference name expressions (see linkgit:git-rev-parse[1]):
6364

6465
. at-open-brace `@{` is used as a notation to access a reflog entry.
6566

67+
With the `--print` option, if 'refname' is acceptable, it prints the
68+
canonicalized name of a hypothetical reference with that name. That is,
69+
it prints 'refname' with any extra `/` characters removed.
70+
6671
With the `--branch` option, it expands the ``previous branch syntax''
6772
`@{-n}`. For example, `@{-1}` is a way to refer the last branch you
6873
were on. This option should be used by porcelains to accept this
6974
syntax anywhere a branch name is expected, so they can act as if you
7075
typed the branch name.
7176

72-
EXAMPLE
73-
-------
74-
75-
git check-ref-format --branch @{-1}::
76-
77-
Print the name of the previous branch.
77+
EXAMPLES
78+
--------
7879

80+
* Print the name of the previous branch:
81+
+
82+
------------
83+
$ git check-ref-format --branch @{-1}
84+
------------
85+
86+
* Determine the reference name to use for a new branch:
87+
+
88+
------------
89+
$ ref=$(git check-ref-format --print "refs/heads/$newbranch") ||
90+
die "we do not like '$newbranch' as a branch name."
91+
------------
7992

8093
GIT
8194
---

‎git-describe.html‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -380,7 +380,9 @@ <h2 id="_options">OPTIONS</h2>
380380
<dd>
381381
<p>
382382
Instead of using the default 7 hexadecimal digits as the
383-
abbreviated object name, use &lt;n&gt; digits.
383+
abbreviated object name, use &lt;n&gt; digits, or as many digits
384+
as needed to form a unique object name. An &lt;n&gt; of 0
385+
will suppress long format, only showing the closest tag.
384386
</p>
385387
</dd>
386388
<dt>
@@ -424,8 +426,8 @@ <h2 id="_options">OPTIONS</h2>
424426
This is useful when you want to see parts of the commit object name
425427
in "describe" output, even when the commit in question happens to be
426428
a tagged version. Instead of just emitting the tag name, it will
427-
describe such a commit as v1.2-0-deadbeef (0th commit since tag v1.2
428-
that points at object deadbeef&#8230;.).
429+
describe such a commit as v1.2-0-gdeadbee (0th commit since tag v1.2
430+
that points at object deadbee&#8230;.).
429431
</p>
430432
</dd>
431433
<dt>
@@ -479,7 +481,7 @@ <h2 id="_examples">EXAMPLES</h2>
479481
</div></div>
480482
<div class="literalblock">
481483
<div class="content">
482-
<pre><tt>[torvalds@g5 git]$ git describe --all HEAD^
484+
<pre><tt>[torvalds@g5 git]$ git describe --all --abbrev=4 HEAD^
483485
heads/lt/describe-7-g975b</tt></pre>
484486
</div></div>
485487
<div class="para"><p>With --abbrev set to 0, the command can be used to find the
@@ -489,6 +491,11 @@ <h2 id="_examples">EXAMPLES</h2>
489491
<pre><tt>[torvalds@g5 git]$ git describe --abbrev=0 v1.0.5^2
490492
tags/v1.0.0</tt></pre>
491493
</div></div>
494+
<div class="para"><p>Note that the suffix you get if you type these commands today may be
495+
longer than what Linus saw above when he ran this command, as your
496+
git repository may have new commits whose object names begin with
497+
975b that did not exist back then, and "-g975b" suffix alone may not
498+
be sufficient to disambiguate these commits.</p></div>
492499
</div>
493500
<h2 id="_search_strategy">SEARCH STRATEGY</h2>
494501
<div class="sectionbody">
@@ -523,7 +530,7 @@ <h2 id="_git">GIT</h2>
523530
</div>
524531
<div id="footer">
525532
<div id="footer-text">
526-
Last updated 2009-07-01 02:30:47 UTC
533+
Last updated 2009-10-31 04:03:03 UTC
527534
</div>
528535
</div>
529536
</body>

‎git-describe.txt‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@ OPTIONS
4444

4545
--abbrev=<n>::
4646
Instead of using the default 7 hexadecimal digits as the
47-
abbreviated object name, use <n> digits.
47+
abbreviated object name, use <n> digits, or as many digits
48+
as needed to form a unique object name. An <n> of 0
49+
will suppress long format, only showing the closest tag.
4850

4951
--candidates=<n>::
5052
Instead of considering only the 10 most recent tags as
@@ -68,8 +70,8 @@ OPTIONS
6870
This is useful when you want to see parts of the commit object name
6971
in "describe" output, even when the commit in question happens to be
7072
a tagged version. Instead of just emitting the tag name, it will
71-
describe such a commit as v1.2-0-deadbeef (0th commit since tag v1.2
72-
that points at object deadbeef....).
73+
describe such a commit as v1.2-0-gdeadbee (0th commit since tag v1.2
74+
that points at object deadbee....).
7375

7476
--match <pattern>::
7577
Only consider tags matching the given pattern (can be used to avoid
@@ -108,7 +110,7 @@ the output shows the reference path as well:
108110
[torvalds@g5 git]$ git describe --all --abbrev=4 v1.0.5^2
109111
tags/v1.0.0-21-g975b
110112

111-
[torvalds@g5 git]$ git describe --all HEAD^
113+
[torvalds@g5 git]$ git describe --all --abbrev=4 HEAD^
112114
heads/lt/describe-7-g975b
113115

114116
With --abbrev set to 0, the command can be used to find the
@@ -117,6 +119,13 @@ closest tagname without any suffix:
117119
[torvalds@g5 git]$ git describe --abbrev=0 v1.0.5^2
118120
tags/v1.0.0
119121

122+
Note that the suffix you get if you type these commands today may be
123+
longer than what Linus saw above when he ran this command, as your
124+
git repository may have new commits whose object names begin with
125+
975b that did not exist back then, and "-g975b" suffix alone may not
126+
be sufficient to disambiguate these commits.
127+
128+
120129
SEARCH STRATEGY
121130
---------------
122131

0 commit comments

Comments
 (0)