Skip to content

Commit 3f2f6e5

Browse files
author
Junio C Hamano
committed
Autogenerated HTML docs for v1.6.0-90-g436ed
1 parent 3580ad2 commit 3f2f6e5

10 files changed

+220
-41
lines changed

‎git-count-objects.html‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -340,8 +340,9 @@ <h2 id="_options">OPTIONS</h2>
340340
<p>
341341
In addition to the number of loose objects and disk
342342
space consumed, it reports the number of in-pack
343-
objects, number of packs, and number of objects that can be
344-
removed by running <tt>git prune-packed</tt>.
343+
objects, number of packs, disk space consumed by those packs,
344+
and number of objects that can be removed by running
345+
<tt>git prune-packed</tt>.
345346
</p>
346347
</dd>
347348
</dl></div>
@@ -360,7 +361,7 @@ <h2 id="_git">GIT</h2>
360361
</div>
361362
<div id="footer">
362363
<div id="footer-text">
363-
Last updated 2008-07-22 09:19:05 UTC
364+
Last updated 2008-08-21 10:34:00 UTC
364365
</div>
365366
</div>
366367
</body>

‎git-count-objects.txt‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ OPTIONS
2121
--verbose::
2222
In addition to the number of loose objects and disk
2323
space consumed, it reports the number of in-pack
24-
objects, number of packs, and number of objects that can be
25-
removed by running `git prune-packed`.
24+
objects, number of packs, disk space consumed by those packs,
25+
and number of objects that can be removed by running
26+
`git prune-packed`.
2627

2728

2829
Author

‎git-diff-tree.html‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -862,13 +862,20 @@ <h2 id="_options">OPTIONS</h2>
862862
<p>
863863
When <em>--stdin</em> is specified, the command does not take
864864
&lt;tree-ish&gt; arguments from the command line. Instead, it
865-
reads either one &lt;commit&gt; or a list of &lt;commit&gt;
866-
separated with a single space from its standard input.
865+
reads lines containing either two &lt;tree&gt;, one &lt;commit&gt;, or a
866+
list of &lt;commit&gt; from its standard input. (Use a single space
867+
as separator.)
867868
</p>
868-
<div class="para"><p>When a single commit is given on one line of such input, it compares
869-
the commit with its parents. The following flags further affects its
870-
behavior. The remaining commits, when given, are used as if they are
869+
<div class="para"><p>When two trees are given, it compares the first tree with the second.
870+
When a single commit is given, it compares the commit with its
871+
parents. The remaining commits, when given, are used as if they are
871872
parents of the first commit.</p></div>
873+
<div class="para"><p>When comparing two trees, the ID of both trees (separated by a space
874+
and terminated by a newline) is printed before the difference. When
875+
comparing commits, the ID of the first (or only) commit, followed by a
876+
newline, is printed.</p></div>
877+
<div class="para"><p>The following flags further affects the behavior when comparing
878+
commits (but not trees).</p></div>
872879
</dd>
873880
<dt>
874881
-m
@@ -1855,7 +1862,7 @@ <h2 id="_git">GIT</h2>
18551862
</div>
18561863
<div id="footer">
18571864
<div id="footer-text">
1858-
Last updated 2008-08-20 09:13:30 UTC
1865+
Last updated 2008-08-21 10:34:00 UTC
18591866
</div>
18601867
</div>
18611868
</body>

‎git-diff-tree.txt‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,22 @@ include::diff-options.txt[]
4949
--stdin::
5050
When '--stdin' is specified, the command does not take
5151
<tree-ish> arguments from the command line. Instead, it
52-
reads either one <commit> or a list of <commit>
53-
separated with a single space from its standard input.
52+
reads lines containing either two <tree>, one <commit>, or a
53+
list of <commit> from its standard input. (Use a single space
54+
as separator.)
5455
+
55-
When a single commit is given on one line of such input, it compares
56-
the commit with its parents. The following flags further affects its
57-
behavior. The remaining commits, when given, are used as if they are
56+
When two trees are given, it compares the first tree with the second.
57+
When a single commit is given, it compares the commit with its
58+
parents. The remaining commits, when given, are used as if they are
5859
parents of the first commit.
60+
+
61+
When comparing two trees, the ID of both trees (separated by a space
62+
and terminated by a newline) is printed before the difference. When
63+
comparing commits, the ID of the first (or only) commit, followed by a
64+
newline, is printed.
65+
+
66+
The following flags further affects the behavior when comparing
67+
commits (but not trees).
5968

6069
-m::
6170
By default, 'git-diff-tree --stdin' does not show

‎git-merge-base.html‎

Lines changed: 66 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -320,17 +320,22 @@ <h2>NAME</h2>
320320
</div>
321321
<h2>SYNOPSIS</h2>
322322
<div class="sectionbody">
323-
<div class="para"><p><em>git merge-base</em> [--all] &lt;commit&gt; &lt;commit&gt;</p></div>
323+
<div class="para"><p><em>git merge-base</em> [--all] &lt;commit&gt; &lt;commit&gt;&#8230;</p></div>
324324
</div>
325325
<h2 id="_description">DESCRIPTION</h2>
326326
<div class="sectionbody">
327-
<div class="para"><p><em>git-merge-base</em> finds as good a common ancestor as possible between
328-
the two commits. That is, given two commits A and B, <tt>git merge-base A
329-
B</tt> will output a commit which is reachable from both A and B through
330-
the parent relationship.</p></div>
331-
<div class="para"><p>Given a selection of equally good common ancestors it should not be
332-
relied on to decide in any particular way.</p></div>
333-
<div class="para"><p>The <em>git-merge-base</em> algorithm is still in flux - use the source&#8230;</p></div>
327+
<div class="para"><p><em>git-merge-base</em> finds best common ancestor(s) between two commits to use
328+
in a three-way merge. One common ancestor is <em>better</em> than another common
329+
ancestor if the latter is an ancestor of the former. A common ancestor
330+
that does not have any better common ancestor than it is a <em>best common
331+
ancestor</em>, i.e. a <em>merge base</em>. Note that there can be more than one
332+
merge bases between two commits.</p></div>
333+
<div class="para"><p>Among the two commits to compute their merge bases, one is specified by
334+
the first commit argument on the command line; the other commit is a
335+
(possibly hypothetical) commit that is a merge across all the remaining
336+
commits on the command line. As the most common special case, giving only
337+
two commits from the command line means computing the merge base between
338+
the given two commits.</p></div>
334339
</div>
335340
<h2 id="_options">OPTIONS</h2>
336341
<div class="sectionbody">
@@ -340,12 +345,62 @@ <h2 id="_options">OPTIONS</h2>
340345
</dt>
341346
<dd>
342347
<p>
343-
Output all common ancestors for the two commits instead of
344-
just one.
348+
Output all merge bases for the commits, instead of just one.
345349
</p>
346350
</dd>
347351
</dl></div>
348352
</div>
353+
<h2 id="_discussion">DISCUSSION</h2>
354+
<div class="sectionbody">
355+
<div class="para"><p>Given two commits <em>A</em> and <em>B</em>, <tt>git merge-base A B</tt> will output a commit
356+
which is reachable from both <em>A</em> and <em>B</em> through the parent relationship.</p></div>
357+
<div class="para"><p>For example, with this topology:</p></div>
358+
<div class="literalblock">
359+
<div class="content">
360+
<pre><tt> o---o---o---B
361+
/
362+
---o---1---o---o---o---A</tt></pre>
363+
</div></div>
364+
<div class="para"><p>the merge base between <em>A</em> and <em>B</em> is <em>1</em>.</p></div>
365+
<div class="para"><p>Given three commits <em>A</em>, <em>B</em> and <em>C</em>, <tt>git merge-base A B C</tt> will compute the
366+
merge base between <em>A</em> and an hypothetical commit <em>M</em>, which is a merge
367+
between <em>B</em> and <em>C</em>. For example, with this topology:</p></div>
368+
<div class="literalblock">
369+
<div class="content">
370+
<pre><tt> o---o---o---o---C
371+
/
372+
/ o---o---o---B
373+
/ /
374+
---2---1---o---o---o---A</tt></pre>
375+
</div></div>
376+
<div class="para"><p>the result of <tt>git merge-base A B C</tt> is <em>1</em>. This is because the
377+
equivalent topology with a merge commit <em>M</em> between <em>B</em> and <em>C</em> is:</p></div>
378+
<div class="literalblock">
379+
<div class="content">
380+
<pre><tt> o---o---o---o---o
381+
/ \
382+
/ o---o---o---o---M
383+
/ /
384+
---2---1---o---o---o---A</tt></pre>
385+
</div></div>
386+
<div class="para"><p>and the result of <tt>git merge-base A M</tt> is <em>1</em>. Commit <em>2</em> is also a
387+
common ancestor between <em>A</em> and <em>M</em>, but <em>1</em> is a better common ancestor,
388+
because <em>2</em> is an ancestor of <em>1</em>. Hence, <em>2</em> is not a merge base.</p></div>
389+
<div class="para"><p>When the history involves criss-cross merges, there can be more than one
390+
<em>best</em> common ancestors between two commits. For example, with this
391+
topology:</p></div>
392+
<div class="literalblock">
393+
<div class="content">
394+
<pre><tt>---1---o---A
395+
\ /
396+
X
397+
/ \
398+
---2---o---o---B</tt></pre>
399+
</div></div>
400+
<div class="para"><p>both <em>1</em> and <em>2</em> are merge-base of A and B. Neither one is better than
401+
the other (both are <em>best</em> merge base). When <tt>--all</tt> option is not given,
402+
it is unspecified which best one is output.</p></div>
403+
</div>
349404
<h2 id="_author">Author</h2>
350405
<div class="sectionbody">
351406
<div class="para"><p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p></div>
@@ -360,7 +415,7 @@ <h2 id="_git">GIT</h2>
360415
</div>
361416
<div id="footer">
362417
<div id="footer-text">
363-
Last updated 2008-07-06 05:16:53 UTC
418+
Last updated 2008-08-21 10:34:00 UTC
364419
</div>
365420
</div>
366421
</body>

‎git-merge-base.txt‎

Lines changed: 66 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,81 @@ git-merge-base - Find as good common ancestors as possible for a merge
88

99
SYNOPSIS
1010
--------
11-
'git merge-base' [--all] <commit> <commit>
11+
'git merge-base' [--all] <commit> <commit>...
1212

1313
DESCRIPTION
1414
-----------
1515

16-
'git-merge-base' finds as good a common ancestor as possible between
17-
the two commits. That is, given two commits A and B, `git merge-base A
18-
B` will output a commit which is reachable from both A and B through
19-
the parent relationship.
16+
'git-merge-base' finds best common ancestor(s) between two commits to use
17+
in a three-way merge. One common ancestor is 'better' than another common
18+
ancestor if the latter is an ancestor of the former. A common ancestor
19+
that does not have any better common ancestor than it is a 'best common
20+
ancestor', i.e. a 'merge base'. Note that there can be more than one
21+
merge bases between two commits.
2022

21-
Given a selection of equally good common ancestors it should not be
22-
relied on to decide in any particular way.
23-
24-
The 'git-merge-base' algorithm is still in flux - use the source...
23+
Among the two commits to compute their merge bases, one is specified by
24+
the first commit argument on the command line; the other commit is a
25+
(possibly hypothetical) commit that is a merge across all the remaining
26+
commits on the command line. As the most common special case, giving only
27+
two commits from the command line means computing the merge base between
28+
the given two commits.
2529

2630
OPTIONS
2731
-------
2832
--all::
29-
Output all common ancestors for the two commits instead of
30-
just one.
33+
Output all merge bases for the commits, instead of just one.
34+
35+
DISCUSSION
36+
----------
37+
38+
Given two commits 'A' and 'B', `git merge-base A B` will output a commit
39+
which is reachable from both 'A' and 'B' through the parent relationship.
40+
41+
For example, with this topology:
42+
43+
o---o---o---B
44+
/
45+
---o---1---o---o---o---A
46+
47+
the merge base between 'A' and 'B' is '1'.
48+
49+
Given three commits 'A', 'B' and 'C', `git merge-base A B C` will compute the
50+
merge base between 'A' and an hypothetical commit 'M', which is a merge
51+
between 'B' and 'C'. For example, with this topology:
52+
53+
o---o---o---o---C
54+
/
55+
/ o---o---o---B
56+
/ /
57+
---2---1---o---o---o---A
58+
59+
the result of `git merge-base A B C` is '1'. This is because the
60+
equivalent topology with a merge commit 'M' between 'B' and 'C' is:
61+
62+
63+
o---o---o---o---o
64+
/ \
65+
/ o---o---o---o---M
66+
/ /
67+
---2---1---o---o---o---A
68+
69+
and the result of `git merge-base A M` is '1'. Commit '2' is also a
70+
common ancestor between 'A' and 'M', but '1' is a better common ancestor,
71+
because '2' is an ancestor of '1'. Hence, '2' is not a merge base.
72+
73+
When the history involves criss-cross merges, there can be more than one
74+
'best' common ancestors between two commits. For example, with this
75+
topology:
76+
77+
---1---o---A
78+
\ /
79+
X
80+
/ \
81+
---2---o---o---B
82+
83+
both '1' and '2' are merge-base of A and B. Neither one is better than
84+
the other (both are 'best' merge base). When `--all` option is not given,
85+
it is unspecified which best one is output.
3186

3287
Author
3388
------

‎git-submodule.html‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,8 @@ <h2>SYNOPSIS</h2>
325325
<em>git submodule</em> [--quiet] status [--cached] [--] [&lt;path&gt;&#8230;]
326326
<em>git submodule</em> [--quiet] init [--] [&lt;path&gt;&#8230;]
327327
<em>git submodule</em> [--quiet] update [--init] [--] [&lt;path&gt;&#8230;]
328-
<em>git submodule</em> [--quiet] summary [--summary-limit &lt;n&gt;] [commit] [--] [&lt;path&gt;&#8230;]</div></div>
328+
<em>git submodule</em> [--quiet] summary [--summary-limit &lt;n&gt;] [commit] [--] [&lt;path&gt;&#8230;]
329+
<em>git submodule</em> [--quiet] foreach &lt;command&gt;</div></div>
329330
</div>
330331
<h2 id="_description">DESCRIPTION</h2>
331332
<div class="sectionbody">
@@ -451,6 +452,25 @@ <h2 id="_commands">COMMANDS</h2>
451452
index or working tree (switched by --cached) are shown.
452453
</p>
453454
</dd>
455+
<dt>
456+
foreach
457+
</dt>
458+
<dd>
459+
<p>
460+
Evaluates an arbitrary shell command in each checked out submodule.
461+
The command has access to the variables $path and $sha1:
462+
$path is the name of the submodule directory relative to the
463+
superproject, and $sha1 is the commit as recorded in the superproject.
464+
Any submodules defined in the superproject but not checked out are
465+
ignored by this command. Unless given --quiet, foreach prints the name
466+
of each submodule before evaluating the command.
467+
A non-zero return from the command in any submodule causes
468+
the processing to terminate. This can be overridden by adding <em>|| :</em>
469+
to the end of the command.
470+
</p>
471+
<div class="para"><p>As an example, "git submodule foreach <em>echo $path <tt>git rev-parse HEAD</tt></em> will
472+
show the path and currently checked out commit for each submodule.</p></div>
473+
</dd>
454474
</dl></div>
455475
</div>
456476
<h2 id="_options">OPTIONS</h2>
@@ -533,7 +553,7 @@ <h2 id="_git">GIT</h2>
533553
</div>
534554
<div id="footer">
535555
<div id="footer-text">
536-
Last updated 2008-07-31 22:10:24 UTC
556+
Last updated 2008-08-21 10:34:01 UTC
537557
</div>
538558
</div>
539559
</body>

‎git-submodule.txt‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ SYNOPSIS
1414
'git submodule' [--quiet] init [--] [<path>...]
1515
'git submodule' [--quiet] update [--init] [--] [<path>...]
1616
'git submodule' [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>...]
17+
'git submodule' [--quiet] foreach <command>
1718

1819

1920
DESCRIPTION
@@ -123,6 +124,22 @@ summary::
123124
in the submodule between the given super project commit and the
124125
index or working tree (switched by --cached) are shown.
125126

127+
foreach::
128+
Evaluates an arbitrary shell command in each checked out submodule.
129+
The command has access to the variables $path and $sha1:
130+
$path is the name of the submodule directory relative to the
131+
superproject, and $sha1 is the commit as recorded in the superproject.
132+
Any submodules defined in the superproject but not checked out are
133+
ignored by this command. Unless given --quiet, foreach prints the name
134+
of each submodule before evaluating the command.
135+
A non-zero return from the command in any submodule causes
136+
the processing to terminate. This can be overridden by adding '|| :'
137+
to the end of the command.
138+
+
139+
As an example, "git submodule foreach 'echo $path `git rev-parse HEAD`' will
140+
show the path and currently checked out commit for each submodule.
141+
142+
126143
OPTIONS
127144
-------
128145
-q::

0 commit comments

Comments
 (0)