Autogenerated HTML docs for v1.2.0-g6a9b
[git.git] / git-rev-list.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
4 <head>\r
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
6 <meta name="generator" content="AsciiDoc 7.0.1" />\r
7 <style type="text/css">\r
8 /* Debug borders */\r
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
10 /*\r
11   border: 1px solid red;\r
12 */\r
13 }\r
14 \r
15 body {\r
16   margin: 1em 5% 1em 5%;\r
17 }\r
18 \r
19 a { color: blue; }\r
20 a:visited { color: fuchsia; }\r
21 \r
22 em {\r
23   font-style: italic;\r
24 }\r
25 \r
26 strong {\r
27   font-weight: bold;\r
28 }\r
29 \r
30 tt {\r
31   color: navy;\r
32 }\r
33 \r
34 h1, h2, h3, h4, h5, h6 {\r
35   color: #527bbd;\r
36   font-family: sans-serif;\r
37   margin-top: 1.2em;\r
38   margin-bottom: 0.5em;\r
39   line-height: 1.3;\r
40 }\r
41 \r
42 h1 {\r
43   border-bottom: 2px solid silver;\r
44 }\r
45 h2 {\r
46   border-bottom: 2px solid silver;\r
47   padding-top: 0.5em;\r
48 }\r
49 \r
50 div.sectionbody {\r
51   font-family: serif;\r
52   margin-left: 0;\r
53 }\r
54 \r
55 hr {\r
56   border: 1px solid silver;\r
57 }\r
58 \r
59 p {\r
60   margin-top: 0.5em;\r
61   margin-bottom: 0.5em;\r
62 }\r
63 \r
64 pre {\r
65   padding: 0;\r
66   margin: 0;\r
67 }\r
68 \r
69 span#author {\r
70   color: #527bbd;\r
71   font-family: sans-serif;\r
72   font-weight: bold;\r
73   font-size: 1.2em;\r
74 }\r
75 span#email {\r
76 }\r
77 span#revision {\r
78   font-family: sans-serif;\r
79 }\r
80 \r
81 div#footer {\r
82   font-family: sans-serif;\r
83   font-size: small;\r
84   border-top: 2px solid silver;\r
85   padding-top: 0.5em;\r
86   margin-top: 4.0em;\r
87 }\r
88 div#footer-text {\r
89   float: left;\r
90   padding-bottom: 0.5em;\r
91 }\r
92 div#footer-badges {\r
93   float: right;\r
94   padding-bottom: 0.5em;\r
95 }\r
96 \r
97 div#preamble,\r
98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
100 div.admonitionblock {\r
101   margin-right: 10%;\r
102   margin-top: 1.5em;\r
103   margin-bottom: 1.5em;\r
104 }\r
105 div.admonitionblock {\r
106   margin-top: 2.5em;\r
107   margin-bottom: 2.5em;\r
108 }\r
109 \r
110 div.content { /* Block element content. */\r
111   padding: 0;\r
112 }\r
113 \r
114 /* Block element titles. */\r
115 div.title, caption.title {\r
116   font-family: sans-serif;\r
117   font-weight: bold;\r
118   text-align: left;\r
119   margin-top: 1.0em;\r
120   margin-bottom: 0.5em;\r
121 }\r
122 div.title + * {\r
123   margin-top: 0;\r
124 }\r
125 \r
126 td div.title:first-child {\r
127   margin-top: 0.0em;\r
128 }\r
129 div.content div.title:first-child {\r
130   margin-top: 0.0em;\r
131 }\r
132 div.content + div.title {\r
133   margin-top: 0.0em;\r
134 }\r
135 \r
136 div.sidebarblock > div.content {\r
137   background: #ffffee;\r
138   border: 1px solid silver;\r
139   padding: 0.5em;\r
140 }\r
141 \r
142 div.listingblock > div.content {\r
143   border: 1px solid silver;\r
144   background: #f4f4f4;\r
145   padding: 0.5em;\r
146 }\r
147 \r
148 div.quoteblock > div.content {\r
149   padding-left: 2.0em;\r
150 }\r
151 div.quoteblock .attribution {\r
152   text-align: right;\r
153 }\r
154 \r
155 div.admonitionblock .icon {\r
156   vertical-align: top;\r
157   font-size: 1.1em;\r
158   font-weight: bold;\r
159   text-decoration: underline;\r
160   color: #527bbd;\r
161   padding-right: 0.5em;\r
162 }\r
163 div.admonitionblock td.content {\r
164   padding-left: 0.5em;\r
165   border-left: 2px solid silver;\r
166 }\r
167 \r
168 div.exampleblock > div.content {\r
169   border-left: 2px solid silver;\r
170   padding: 0.5em;\r
171 }\r
172 \r
173 div.verseblock div.content {\r
174   white-space: pre;\r
175 }\r
176 \r
177 div.imageblock div.content { padding-left: 0; }\r
178 div.imageblock img { border: 1px solid silver; }\r
179 span.image img { border-style: none; }\r
180 \r
181 dl {\r
182   margin-top: 0.8em;\r
183   margin-bottom: 0.8em;\r
184 }\r
185 dt {\r
186   margin-top: 0.5em;\r
187   margin-bottom: 0;\r
188   font-style: italic;\r
189 }\r
190 dd > *:first-child {\r
191   margin-top: 0;\r
192 }\r
193 \r
194 ul, ol {\r
195     list-style-position: outside;\r
196 }\r
197 ol.olist2 {\r
198   list-style-type: lower-alpha;\r
199 }\r
200 \r
201 div.tableblock > table {\r
202   border-color: #527bbd;\r
203   border-width: 3px;\r
204 }\r
205 thead {\r
206   font-family: sans-serif;\r
207   font-weight: bold;\r
208 }\r
209 tfoot {\r
210   font-weight: bold;\r
211 }\r
212 \r
213 div.hlist {\r
214   margin-top: 0.8em;\r
215   margin-bottom: 0.8em;\r
216 }\r
217 td.hlist1 {\r
218   vertical-align: top;\r
219   font-style: italic;\r
220   padding-right: 0.8em;\r
221 }\r
222 td.hlist2 {\r
223   vertical-align: top;\r
224 }\r
225 \r
226 @media print {\r
227   div#footer-badges { display: none; }\r
228 }\r
229 include::./stylesheets/xhtml11-manpage.css[]\r
230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
231 \r
232 div.sidebar-content {\r
233   background: #ffffee;\r
234   border: 1px solid silver;\r
235   padding: 0.5em;\r
236 }\r
237 div.sidebar-title, div.image-title {\r
238   font-family: sans-serif;\r
239   font-weight: bold;\r
240   margin-top: 0.0em;\r
241   margin-bottom: 0.5em;\r
242 }\r
243 \r
244 div.listingblock div.content {\r
245   border: 1px solid silver;\r
246   background: #f4f4f4;\r
247   padding: 0.5em;\r
248 }\r
249 \r
250 div.quoteblock-content {\r
251   padding-left: 2.0em;\r
252 }\r
253 \r
254 div.exampleblock-content {\r
255   border-left: 2px solid silver;\r
256   padding-left: 0.5em;\r
257 }\r
258 </style>\r
259 <title>git-rev-list(1)</title>\r
260 </head>\r
261 <body>\r
262 <div id="header">\r
263 <h1>\r
264 git-rev-list(1) Manual Page\r
265 </h1>\r
266 <h2>NAME</h2>\r
267 <div class="sectionbody">\r
268 <p>git-rev-list -\r
269    Lists commit objects in reverse chronological order\r
270 </p>\r
271 </div>\r
272 </div>\r
273 <h2>SYNOPSIS</h2>\r
274 <div class="sectionbody">\r
275 <div class="verseblock">\r
276 <div class="content"><em>git-rev-list</em> [ --max-count=number ]\r
277              [ --max-age=timestamp ]\r
278              [ --min-age=timestamp ]\r
279              [ --sparse ]\r
280              [ --no-merges ]\r
281              [ --remove-empty ]\r
282              [ --all ]\r
283              [ [ --merge-order [ --show-breaks ] ] | [ --topo-order ] ]\r
284              [ --parents ]\r
285              [ --objects [ --unpacked ] ]\r
286              [ --pretty | --header ]\r
287              [ --bisect ]\r
288              &lt;commit&gt;&#8230; [ -- &lt;paths&gt;&#8230; ]</div></div>\r
289 </div>\r
290 <h2>DESCRIPTION</h2>\r
291 <div class="sectionbody">\r
292 <p>Lists commit objects in reverse chronological order starting at the\r
293 given commit(s), taking ancestry relationship into account.  This is\r
294 useful to produce human-readable log output.</p>\r
295 <p>Commits which are stated with a preceding <em>^</em> cause listing to stop at\r
296 that point. Their parents are implied. "git-rev-list foo bar ^baz" thus\r
297 means "list all the commits which are included in <em>foo</em> and <em>bar</em>, but\r
298 not in <em>baz</em>".</p>\r
299 <p>A special notation &lt;commit1&gt;..&lt;commit2&gt; can be used as a\r
300 short-hand for ^&lt;commit1&gt; &lt;commit2&gt;.</p>\r
301 </div>\r
302 <h2>OPTIONS</h2>\r
303 <div class="sectionbody">\r
304 <dl>\r
305 <dt>\r
306 --pretty\r
307 </dt>\r
308 <dd>\r
309 <p>\r
310         Print the contents of the commit changesets in human-readable form.\r
311 </p>\r
312 </dd>\r
313 <dt>\r
314 --header\r
315 </dt>\r
316 <dd>\r
317 <p>\r
318         Print the contents of the commit in raw-format; each\r
319         record is separated with a NUL character.\r
320 </p>\r
321 </dd>\r
322 <dt>\r
323 --objects\r
324 </dt>\r
325 <dd>\r
326 <p>\r
327         Print the object IDs of any object referenced by the listed commits.\r
328         <em>git-rev-list --objects foo ^bar</em> thus means "send me all object IDs\r
329         which I need to download if I have the commit object <em>bar</em>, but\r
330         not <em>foo</em>".\r
331 </p>\r
332 </dd>\r
333 <dt>\r
334 --unpacked\r
335 </dt>\r
336 <dd>\r
337 <p>\r
338         Only useful with <tt>--objects</tt>; print the object IDs that\r
339         are not in packs.\r
340 </p>\r
341 </dd>\r
342 <dt>\r
343 --bisect\r
344 </dt>\r
345 <dd>\r
346 <p>\r
347         Limit output to the one commit object which is roughly halfway\r
348         between the included and excluded commits. Thus, if <em>git-rev-list\r
349         --bisect foo <sup>bar </sup>baz</em> outputs <em>midpoint</em>, the output\r
350         of <em>git-rev-list foo ^midpoint</em> and <em>git-rev-list midpoint\r
351         <sup>bar </sup>baz</em> would be of roughly the same length. Finding the change\r
352         which introduces a regression is thus reduced to a binary search:\r
353         repeatedly generate and test new 'midpoint's until the commit chain\r
354         is of length one.\r
355 </p>\r
356 </dd>\r
357 <dt>\r
358 --max-count\r
359 </dt>\r
360 <dd>\r
361 <p>\r
362         Limit the number of commits output.\r
363 </p>\r
364 </dd>\r
365 <dt>\r
366 --max-age=timestamp, --min-age=timestamp\r
367 </dt>\r
368 <dd>\r
369 <p>\r
370         Limit the commits output to specified time range.\r
371 </p>\r
372 </dd>\r
373 <dt>\r
374 --sparse\r
375 </dt>\r
376 <dd>\r
377 <p>\r
378         When optional paths are given, the command outputs only\r
379         the commits that changes at least one of them, and also\r
380         ignores merges that do not touch the given paths.  This\r
381         flag makes the command output all eligible commits\r
382         (still subject to count and age limitation), but apply\r
383         merge simplification nevertheless.\r
384 </p>\r
385 </dd>\r
386 <dt>\r
387 --remove-empty\r
388 </dt>\r
389 <dd>\r
390 <p>\r
391         Stop when a given path disappears from the tree.\r
392 </p>\r
393 </dd>\r
394 <dt>\r
395 --all\r
396 </dt>\r
397 <dd>\r
398 <p>\r
399         Pretend as if all the refs in <tt>$GIT_DIR/refs/</tt> are\r
400         listed on the command line as &lt;commit&gt;.\r
401 </p>\r
402 </dd>\r
403 <dt>\r
404 --topo-order\r
405 </dt>\r
406 <dd>\r
407 <p>\r
408         By default, the commits are shown in reverse\r
409         chronological order.  This option makes them appear in\r
410         topological order (i.e. descendant commits are shown\r
411         before their parents).\r
412 </p>\r
413 </dd>\r
414 <dt>\r
415 --merge-order\r
416 </dt>\r
417 <dd>\r
418 <p>\r
419         When specified the commit history is decomposed into a unique\r
420         sequence of minimal, non-linear epochs and maximal, linear epochs.\r
421         Non-linear epochs are then linearised by sorting them into merge\r
422         order, which is described below.\r
423 </p>\r
424 <p>Maximal, linear epochs correspond to periods of sequential development.\r
425 Minimal, non-linear epochs correspond to periods of divergent development\r
426 followed by a converging merge. The theory of epochs is described in more\r
427 detail at\r
428 <a href="http://blackcubes.dyndns.org/epoch/">http://blackcubes.dyndns.org/epoch/</a>.</p>\r
429 <p>The merge order for a non-linear epoch is defined as a linearisation for which\r
430 the following invariants are true:</p>\r
431 <ol>\r
432 <li>\r
433 <p>\r
434 if a commit P is reachable from commit N, commit P sorts after commit N\r
435        in the linearised list.\r
436 </p>\r
437 </li>\r
438 <li>\r
439 <p>\r
440 if Pi and Pj are any two parents of a merge M (with i &lt; j), then any\r
441        commit N, such that N is reachable from Pj but not reachable from Pi,\r
442        sorts before all commits reachable from Pi.\r
443 </p>\r
444 <p>Invariant 1 states that later commits appear before earlier commits they are\r
445 derived from.</p>\r
446 <p>Invariant 2 states that commits unique to "later" parents in a merge, appear\r
447 before all commits from "earlier" parents of a merge.</p>\r
448 </li>\r
449 </ol>\r
450 </dd>\r
451 <dt>\r
452 --show-breaks\r
453 </dt>\r
454 <dd>\r
455 <p>\r
456         Each item of the list is output with a 2-character prefix consisting\r
457         of one of: (|), (^), (=) followed by a space.\r
458 </p>\r
459 <p>Commits marked with (=) represent the boundaries of minimal, non-linear epochs\r
460 and correspond either to the start of a period of divergent development or to\r
461 the end of such a period.</p>\r
462 <p>Commits marked with (|) are direct parents of commits immediately preceding\r
463 the marked commit in the list.</p>\r
464 <p>Commits marked with (^) are not parents of the immediately preceding commit.\r
465 These "breaks" represent necessary discontinuities implied by trying to\r
466 represent an arbitrary DAG in a linear form.</p>\r
467 <p><tt>--show-breaks</tt> is only valid if <tt>--merge-order</tt> is also specified.</p>\r
468 </dd>\r
469 </dl>\r
470 </div>\r
471 <h2>Author</h2>\r
472 <div class="sectionbody">\r
473 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
474 <p>Original <strong>--merge-order</strong> logic by Jon Seymour &lt;jon.seymour@gmail.com&gt;</p>\r
475 </div>\r
476 <h2>Documentation</h2>\r
477 <div class="sectionbody">\r
478 <p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
479 </div>\r
480 <h2>GIT</h2>\r
481 <div class="sectionbody">\r
482 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
483 </div>\r
484 <div id="footer">\r
485 <div id="footer-text">\r
486 Last updated 28-Jan-2006 00:54:44 PDT\r
487 </div>\r
488 </div>\r
489 </body>\r
490 </html>\r