OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-rev-list.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-rev-list(1)">\r
5 <articleinfo>\r
6     <title>git-rev-list(1)</title>\r
7         <indexterm>\r
8                 <primary>git-rev-list(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-rev-list - Lists commit objects in reverse chronological order</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>git-rev-list</emphasis> [ --max-count=number ]\r
19              [ --skip=number ]\r
20              [ --max-age=timestamp ]\r
21              [ --min-age=timestamp ]\r
22              [ --sparse ]\r
23              [ --no-merges ]\r
24              [ --first-parent ]\r
25              [ --remove-empty ]\r
26              [ --full-history ]\r
27              [ --not ]\r
28              [ --all ]\r
29              [ --branches ]\r
30              [ --tags ]\r
31              [ --remotes ]\r
32              [ --stdin ]\r
33              [ --quiet ]\r
34              [ --topo-order ]\r
35              [ --parents ]\r
36              [ --timestamp ]\r
37              [ --left-right ]\r
38              [ --cherry-pick ]\r
39              [ --encoding[=&lt;encoding&gt;] ]\r
40              [ --(author|committer|grep)=&lt;pattern&gt; ]\r
41              [ --regexp-ignore-case | -i ]\r
42              [ --extended-regexp | -E ]\r
43              [ --fixed-strings | -F ]\r
44              [ --date={local|relative|default|iso|rfc|short} ]\r
45              [ [--objects | --objects-edge] [ --unpacked ] ]\r
46              [ --pretty | --header ]\r
47              [ --bisect ]\r
48              [ --bisect-vars ]\r
49              [ --bisect-all ]\r
50              [ --merge ]\r
51              [ --reverse ]\r
52              [ --walk-reflogs ]\r
53              [ --no-walk ] [ --do-walk ]\r
54              &lt;commit&gt;&#8230; [ -- &lt;paths&gt;&#8230; ]</literallayout>\r
55 </blockquote>\r
56 </simplesect>\r
57 <simplesect id="_description">\r
58 <title>DESCRIPTION</title>\r
59 <simpara>Lists commit objects in reverse chronological order starting at the\r
60 given commit(s), taking ancestry relationship into account.  This is\r
61 useful to produce human-readable log output.</simpara>\r
62 <simpara>Commits which are stated with a preceding <emphasis>&#94;</emphasis> cause listing to\r
63 stop at that point. Their parents are implied. Thus the following\r
64 command:</simpara>\r
65 <literallayout>        $ git rev-list foo bar ^baz</literallayout>\r
66 <simpara>means "list all the commits which are included in <emphasis>foo</emphasis> and <emphasis>bar</emphasis>, but\r
67 not in <emphasis>baz</emphasis>".</simpara>\r
68 <simpara>A special notation "<emphasis>&lt;commit1&gt;</emphasis>..<emphasis>&lt;commit2&gt;</emphasis>" can be used as a\r
69 short-hand for "&#94;<emphasis>&lt;commit1&gt;</emphasis> <emphasis>&lt;commit2&gt;</emphasis>". For example, either of\r
70 the following may be used interchangeably:</simpara>\r
71 <literallayout>        $ git rev-list origin..HEAD\r
72         $ git rev-list HEAD ^origin</literallayout>\r
73 <simpara>Another special notation is "<emphasis>&lt;commit1&gt;</emphasis>&#8230;<emphasis>&lt;commit2&gt;</emphasis>" which is useful\r
74 for merges.  The resulting set of commits is the symmetric difference\r
75 between the two operands.  The following two commands are equivalent:</simpara>\r
76 <literallayout>        $ git rev-list A B --not $(git merge-base --all A B)\r
77         $ git rev-list A...B</literallayout>\r
78 <simpara><emphasis>git-rev-list</emphasis> is a very essential git program, since it\r
79 provides the ability to build and traverse commit ancestry graphs. For\r
80 this reason, it has a lot of different options that enables it to be\r
81 used by commands as different as <emphasis>git-bisect</emphasis> and\r
82 <emphasis>git-repack</emphasis>.</simpara>\r
83 </simplesect>\r
84 <simplesect id="_options">\r
85 <title>OPTIONS</title>\r
86 <simplesect id="_commit_formatting">\r
87 <title>Commit Formatting</title>\r
88 <simpara>Using these options, <xref linkend="git-rev-list(1)"/> will act similar to the\r
89 more specialized family of commit log tools: <xref linkend="git-log(1)"/>,\r
90 <xref linkend="git-show(1)"/>, and <xref linkend="git-whatchanged(1)"/></simpara>\r
91 <variablelist>\r
92 <varlistentry>\r
93 <term>\r
94 --pretty[=<emphasis>&lt;format&gt;</emphasis>]\r
95 </term>\r
96 <listitem>\r
97 <simpara>\r
98         Pretty-print the contents of the commit logs in a given format,\r
99         where <emphasis>&lt;format&gt;</emphasis> can be one of <emphasis>oneline</emphasis>, <emphasis>short</emphasis>, <emphasis>medium</emphasis>,\r
100         <emphasis>full</emphasis>, <emphasis>fuller</emphasis>, <emphasis>email</emphasis>, <emphasis>raw</emphasis> and <emphasis>format:&lt;string&gt;</emphasis>.\r
101         When omitted, the format defaults to <emphasis>medium</emphasis>.\r
102 </simpara>\r
103 <simpara>Note: you can specify the default pretty format in the repository\r
104 configuration (see <xref linkend="git-config(1)"/>).</simpara>\r
105 </listitem>\r
106 </varlistentry>\r
107 <varlistentry>\r
108 <term>\r
109 --abbrev-commit\r
110 </term>\r
111 <listitem>\r
112 <simpara>\r
113         Instead of showing the full 40-byte hexadecimal commit object\r
114         name, show only a partial prefix.  Non default number of\r
115         digits can be specified with "--abbrev=&lt;n&gt;" (which also modifies\r
116         diff output, if it is displayed).\r
117 </simpara>\r
118 <simpara>This should make "--pretty=oneline" a whole lot more readable for\r
119 people using 80-column terminals.</simpara>\r
120 </listitem>\r
121 </varlistentry>\r
122 <varlistentry>\r
123 <term>\r
124 --encoding[=&lt;encoding&gt;]\r
125 </term>\r
126 <listitem>\r
127 <simpara>\r
128         The commit objects record the encoding used for the log message\r
129         in their encoding header; this option can be used to tell the\r
130         command to re-code the commit log message in the encoding\r
131         preferred by the user.  For non plumbing commands this\r
132         defaults to UTF-8.\r
133 </simpara>\r
134 </listitem>\r
135 </varlistentry>\r
136 <varlistentry>\r
137 <term>\r
138 --relative-date\r
139 </term>\r
140 <listitem>\r
141 <simpara>\r
142         Synonym for <literal>--date=relative</literal>.\r
143 </simpara>\r
144 </listitem>\r
145 </varlistentry>\r
146 <varlistentry>\r
147 <term>\r
148 --date={relative,local,default,iso,rfc,short}\r
149 </term>\r
150 <listitem>\r
151 <simpara>\r
152         Only takes effect for dates shown in human-readable format, such\r
153         as when using "--pretty". <literal>log.date</literal> config variable sets a default\r
154         value for log command&#8217;s --date option.\r
155 </simpara>\r
156 <simpara><literal>--date=relative</literal> shows dates relative to the current time,\r
157 e.g. "2 hours ago".</simpara>\r
158 <simpara><literal>--date=local</literal> shows timestamps in user&#8217;s local timezone.</simpara>\r
159 <simpara><literal>--date=iso</literal> (or <literal>--date=iso8601</literal>) shows timestamps in ISO 8601 format.</simpara>\r
160 <simpara><literal>--date=rfc</literal> (or <literal>--date=rfc2822</literal>) shows timestamps in RFC 2822\r
161 format, often found in E-mail messages.</simpara>\r
162 <simpara><literal>--date=short</literal> shows only date but not time, in <literal>YYYY-MM-DD</literal> format.</simpara>\r
163 <simpara><literal>--date=default</literal> shows timestamps in the original timezone\r
164 (either committer&#8217;s or author&#8217;s).</simpara>\r
165 </listitem>\r
166 </varlistentry>\r
167 <varlistentry>\r
168 <term>\r
169 --header\r
170 </term>\r
171 <listitem>\r
172 <simpara>\r
173         Print the contents of the commit in raw-format; each record is\r
174         separated with a NUL character.\r
175 </simpara>\r
176 </listitem>\r
177 </varlistentry>\r
178 <varlistentry>\r
179 <term>\r
180 --parents\r
181 </term>\r
182 <listitem>\r
183 <simpara>\r
184         Print the parents of the commit.  Also enables parent\r
185         rewriting, see <emphasis>History Simplification</emphasis> below.\r
186 </simpara>\r
187 </listitem>\r
188 </varlistentry>\r
189 <varlistentry>\r
190 <term>\r
191 --children\r
192 </term>\r
193 <listitem>\r
194 <simpara>\r
195         Print the children of the commit.  Also enables parent\r
196         rewriting, see <emphasis>History Simplification</emphasis> below.\r
197 </simpara>\r
198 </listitem>\r
199 </varlistentry>\r
200 <varlistentry>\r
201 <term>\r
202 --timestamp\r
203 </term>\r
204 <listitem>\r
205 <simpara>\r
206         Print the raw commit timestamp.\r
207 </simpara>\r
208 </listitem>\r
209 </varlistentry>\r
210 <varlistentry>\r
211 <term>\r
212 --left-right\r
213 </term>\r
214 <listitem>\r
215 <simpara>\r
216         Mark which side of a symmetric diff a commit is reachable from.\r
217         Commits from the left side are prefixed with <literal>&lt;</literal> and those from\r
218         the right with <literal>&gt;</literal>.  If combined with <literal>--boundary</literal>, those\r
219         commits are prefixed with <literal>-</literal>.\r
220 </simpara>\r
221 <simpara>For example, if you have this topology:</simpara>\r
222 <literallayout>             y---b---b  branch B\r
223             / \ /\r
224            /   .\r
225           /   / \\r
226          o---x---a---a  branch A</literallayout>\r
227 <simpara>you would get an output like this:</simpara>\r
228 <literallayout>        $ git rev-list --left-right --boundary --pretty=oneline A...B\r
229 \r
230         &gt;bbbbbbb... 3rd on b\r
231         &gt;bbbbbbb... 2nd on b\r
232         &lt;aaaaaaa... 3rd on a\r
233         &lt;aaaaaaa... 2nd on a\r
234         -yyyyyyy... 1st on b\r
235         -xxxxxxx... 1st on a</literallayout>\r
236 </listitem>\r
237 </varlistentry>\r
238 <varlistentry>\r
239 <term>\r
240 --graph\r
241 </term>\r
242 <listitem>\r
243 <simpara>\r
244         Draw a text-based graphical representation of the commit history\r
245         on the left hand side of the output.  This may cause extra lines\r
246         to be printed in between commits, in order for the graph history\r
247         to be drawn properly.\r
248 </simpara>\r
249 <simpara>This implies the <emphasis>--topo-order</emphasis> option by default, but the\r
250 <emphasis>--date-order</emphasis> option may also be specified.</simpara>\r
251 </listitem>\r
252 </varlistentry>\r
253 </variablelist>\r
254 </simplesect>\r
255 <simplesect id="_commit_limiting">\r
256 <title>Commit Limiting</title>\r
257 <simpara>Besides specifying a range of commits that should be listed using the\r
258 special notations explained in the description, additional commit\r
259 limiting may be applied.</simpara>\r
260 <variablelist>\r
261 <varlistentry>\r
262 <term>\r
263 -n <emphasis>number</emphasis>\r
264 </term>\r
265 <term>\r
266 --max-count=<emphasis>number</emphasis>\r
267 </term>\r
268 <listitem>\r
269 <simpara>\r
270         Limit the number of commits output.\r
271 </simpara>\r
272 </listitem>\r
273 </varlistentry>\r
274 <varlistentry>\r
275 <term>\r
276 --skip=<emphasis>number</emphasis>\r
277 </term>\r
278 <listitem>\r
279 <simpara>\r
280         Skip <emphasis>number</emphasis> commits before starting to show the commit output.\r
281 </simpara>\r
282 </listitem>\r
283 </varlistentry>\r
284 <varlistentry>\r
285 <term>\r
286 --since=<emphasis>date</emphasis>\r
287 </term>\r
288 <term>\r
289 --after=<emphasis>date</emphasis>\r
290 </term>\r
291 <listitem>\r
292 <simpara>\r
293         Show commits more recent than a specific date.\r
294 </simpara>\r
295 </listitem>\r
296 </varlistentry>\r
297 <varlistentry>\r
298 <term>\r
299 --until=<emphasis>date</emphasis>\r
300 </term>\r
301 <term>\r
302 --before=<emphasis>date</emphasis>\r
303 </term>\r
304 <listitem>\r
305 <simpara>\r
306         Show commits older than a specific date.\r
307 </simpara>\r
308 </listitem>\r
309 </varlistentry>\r
310 <varlistentry>\r
311 <term>\r
312 --max-age=<emphasis>timestamp</emphasis>\r
313 </term>\r
314 <term>\r
315 --min-age=<emphasis>timestamp</emphasis>\r
316 </term>\r
317 <listitem>\r
318 <simpara>\r
319         Limit the commits output to specified time range.\r
320 </simpara>\r
321 </listitem>\r
322 </varlistentry>\r
323 <varlistentry>\r
324 <term>\r
325 --author=<emphasis>pattern</emphasis>\r
326 </term>\r
327 <term>\r
328 --committer=<emphasis>pattern</emphasis>\r
329 </term>\r
330 <listitem>\r
331 <simpara>\r
332         Limit the commits output to ones with author/committer\r
333         header lines that match the specified pattern (regular expression).\r
334 </simpara>\r
335 </listitem>\r
336 </varlistentry>\r
337 <varlistentry>\r
338 <term>\r
339 --grep=<emphasis>pattern</emphasis>\r
340 </term>\r
341 <listitem>\r
342 <simpara>\r
343         Limit the commits output to ones with log message that\r
344         matches the specified pattern (regular expression).\r
345 </simpara>\r
346 </listitem>\r
347 </varlistentry>\r
348 <varlistentry>\r
349 <term>\r
350 --all-match\r
351 </term>\r
352 <listitem>\r
353 <simpara>\r
354         Limit the commits output to ones that match all given --grep,\r
355         --author and --committer instead of ones that match at least one.\r
356 </simpara>\r
357 </listitem>\r
358 </varlistentry>\r
359 <varlistentry>\r
360 <term>\r
361 -i\r
362 </term>\r
363 <term>\r
364 --regexp-ignore-case\r
365 </term>\r
366 <listitem>\r
367 <simpara>\r
368         Match the regexp limiting patterns without regard to letters case.\r
369 </simpara>\r
370 </listitem>\r
371 </varlistentry>\r
372 <varlistentry>\r
373 <term>\r
374 -E\r
375 </term>\r
376 <term>\r
377 --extended-regexp\r
378 </term>\r
379 <listitem>\r
380 <simpara>\r
381         Consider the limiting patterns to be extended regular expressions\r
382         instead of the default basic regular expressions.\r
383 </simpara>\r
384 </listitem>\r
385 </varlistentry>\r
386 <varlistentry>\r
387 <term>\r
388 -F\r
389 </term>\r
390 <term>\r
391 --fixed-strings\r
392 </term>\r
393 <listitem>\r
394 <simpara>\r
395         Consider the limiting patterns to be fixed strings (don&#8217;t interpret\r
396         pattern as a regular expression).\r
397 </simpara>\r
398 </listitem>\r
399 </varlistentry>\r
400 <varlistentry>\r
401 <term>\r
402 --remove-empty\r
403 </term>\r
404 <listitem>\r
405 <simpara>\r
406         Stop when a given path disappears from the tree.\r
407 </simpara>\r
408 </listitem>\r
409 </varlistentry>\r
410 <varlistentry>\r
411 <term>\r
412 --no-merges\r
413 </term>\r
414 <listitem>\r
415 <simpara>\r
416         Do not print commits with more than one parent.\r
417 </simpara>\r
418 </listitem>\r
419 </varlistentry>\r
420 <varlistentry>\r
421 <term>\r
422 --first-parent\r
423 </term>\r
424 <listitem>\r
425 <simpara>\r
426         Follow only the first parent commit upon seeing a merge\r
427         commit.  This option can give a better overview when\r
428         viewing the evolution of a particular topic branch,\r
429         because merges into a topic branch tend to be only about\r
430         adjusting to updated upstream from time to time, and\r
431         this option allows you to ignore the individual commits\r
432         brought in to your history by such a merge.\r
433 </simpara>\r
434 </listitem>\r
435 </varlistentry>\r
436 <varlistentry>\r
437 <term>\r
438 --not\r
439 </term>\r
440 <listitem>\r
441 <simpara>\r
442         Reverses the meaning of the <emphasis>&#94;</emphasis> prefix (or lack thereof)\r
443         for all following revision specifiers, up to the next <emphasis>--not</emphasis>.\r
444 </simpara>\r
445 </listitem>\r
446 </varlistentry>\r
447 <varlistentry>\r
448 <term>\r
449 --all\r
450 </term>\r
451 <listitem>\r
452 <simpara>\r
453         Pretend as if all the refs in <literal>$GIT_DIR/refs/</literal> are listed on the\r
454         command line as <emphasis>&lt;commit&gt;</emphasis>.\r
455 </simpara>\r
456 </listitem>\r
457 </varlistentry>\r
458 <varlistentry>\r
459 <term>\r
460 --branches\r
461 </term>\r
462 <listitem>\r
463 <simpara>\r
464         Pretend as if all the refs in <literal>$GIT_DIR/refs/heads</literal> are listed\r
465         on the command line as <emphasis>&lt;commit&gt;</emphasis>.\r
466 </simpara>\r
467 </listitem>\r
468 </varlistentry>\r
469 <varlistentry>\r
470 <term>\r
471 --tags\r
472 </term>\r
473 <listitem>\r
474 <simpara>\r
475         Pretend as if all the refs in <literal>$GIT_DIR/refs/tags</literal> are listed\r
476         on the command line as <emphasis>&lt;commit&gt;</emphasis>.\r
477 </simpara>\r
478 </listitem>\r
479 </varlistentry>\r
480 <varlistentry>\r
481 <term>\r
482 --remotes\r
483 </term>\r
484 <listitem>\r
485 <simpara>\r
486         Pretend as if all the refs in <literal>$GIT_DIR/refs/remotes</literal> are listed\r
487         on the command line as <emphasis>&lt;commit&gt;</emphasis>.\r
488 </simpara>\r
489 </listitem>\r
490 </varlistentry>\r
491 <varlistentry>\r
492 <term>\r
493 --stdin\r
494 </term>\r
495 <listitem>\r
496 <simpara>\r
497         In addition to the <emphasis>&lt;commit&gt;</emphasis> listed on the command\r
498         line, read them from the standard input.\r
499 </simpara>\r
500 </listitem>\r
501 </varlistentry>\r
502 <varlistentry>\r
503 <term>\r
504 --quiet\r
505 </term>\r
506 <listitem>\r
507 <simpara>\r
508         Don&#8217;t print anything to standard output.  This form\r
509         is primarily meant to allow the caller to\r
510         test the exit status to see if a range of objects is fully\r
511         connected (or not).  It is faster than redirecting stdout\r
512         to /dev/null as the output does not have to be formatted.\r
513 </simpara>\r
514 </listitem>\r
515 </varlistentry>\r
516 <varlistentry>\r
517 <term>\r
518 --cherry-pick\r
519 </term>\r
520 <listitem>\r
521 <simpara>\r
522         Omit any commit that introduces the same change as\r
523         another commit on the "other side" when the set of\r
524         commits are limited with symmetric difference.\r
525 </simpara>\r
526 <simpara>For example, if you have two branches, <literal>A</literal> and <literal>B</literal>, a usual way\r
527 to list all commits on only one side of them is with\r
528 <literal>--left-right</literal>, like the example above in the description of\r
529 that option.  It however shows the commits that were cherry-picked\r
530 from the other branch (for example, "3rd on b" may be cherry-picked\r
531 from branch A).  With this option, such pairs of commits are\r
532 excluded from the output.</simpara>\r
533 </listitem>\r
534 </varlistentry>\r
535 <varlistentry>\r
536 <term>\r
537 -g\r
538 </term>\r
539 <term>\r
540 --walk-reflogs\r
541 </term>\r
542 <listitem>\r
543 <simpara>\r
544         Instead of walking the commit ancestry chain, walk\r
545         reflog entries from the most recent one to older ones.\r
546         When this option is used you cannot specify commits to\r
547         exclude (that is, <emphasis>&#94;commit</emphasis>, <emphasis>commit1..commit2</emphasis>,\r
548         nor <emphasis>commit1&#8230;commit2</emphasis> notations cannot be used).\r
549 </simpara>\r
550 <simpara>With <emphasis>--pretty</emphasis> format other than oneline (for obvious reasons),\r
551 this causes the output to have two extra lines of information\r
552 taken from the reflog.  By default, <emphasis>commit@{Nth}</emphasis> notation is\r
553 used in the output.  When the starting commit is specified as\r
554 <emphasis>commit@{now}</emphasis>, output also uses <emphasis>commit@{timestamp}</emphasis> notation\r
555 instead.  Under <emphasis>--pretty=oneline</emphasis>, the commit message is\r
556 prefixed with this information on the same line.\r
557 This option cannot be combined with <emphasis>--reverse</emphasis>.\r
558 See also <xref linkend="git-reflog(1)"/>.</simpara>\r
559 </listitem>\r
560 </varlistentry>\r
561 <varlistentry>\r
562 <term>\r
563 --merge\r
564 </term>\r
565 <listitem>\r
566 <simpara>\r
567         After a failed merge, show refs that touch files having a\r
568         conflict and don&#8217;t exist on all heads to merge.\r
569 </simpara>\r
570 </listitem>\r
571 </varlistentry>\r
572 <varlistentry>\r
573 <term>\r
574 --boundary\r
575 </term>\r
576 <listitem>\r
577 <simpara>\r
578         Output uninteresting commits at the boundary, which are usually\r
579         not shown.\r
580 </simpara>\r
581 </listitem>\r
582 </varlistentry>\r
583 </variablelist>\r
584 </simplesect>\r
585 <simplesect id="_history_simplification">\r
586 <title>History Simplification</title>\r
587 <simpara>Sometimes you are only interested in parts of the history, for example the\r
588 commits modifying a particular &lt;path&gt;. But there are two parts of\r
589 <emphasis>History Simplification</emphasis>, one part is selecting the commits and the other\r
590 is how to do it, as there are various strategies to simplify the history.</simpara>\r
591 <simpara>The following options select the commits to be shown:</simpara>\r
592 <variablelist>\r
593 <varlistentry>\r
594 <term>\r
595 &lt;paths&gt;\r
596 </term>\r
597 <listitem>\r
598 <simpara>\r
599         Commits modifying the given &lt;paths&gt; are selected.\r
600 </simpara>\r
601 </listitem>\r
602 </varlistentry>\r
603 <varlistentry>\r
604 <term>\r
605 --simplify-by-decoration\r
606 </term>\r
607 <listitem>\r
608 <simpara>\r
609         Commits that are referred by some branch or tag are selected.\r
610 </simpara>\r
611 </listitem>\r
612 </varlistentry>\r
613 </variablelist>\r
614 <simpara>Note that extra commits can be shown to give a meaningful history.</simpara>\r
615 <simpara>The following options affect the way the simplification is performed:</simpara>\r
616 <variablelist>\r
617 <varlistentry>\r
618 <term>\r
619 Default mode\r
620 </term>\r
621 <listitem>\r
622 <simpara>\r
623         Simplifies the history to the simplest history explaining the\r
624         final state of the tree. Simplest because it prunes some side\r
625         branches if the end result is the same (i.e. merging branches\r
626         with the same content)\r
627 </simpara>\r
628 </listitem>\r
629 </varlistentry>\r
630 <varlistentry>\r
631 <term>\r
632 --full-history\r
633 </term>\r
634 <listitem>\r
635 <simpara>\r
636         As the default mode but does not prune some history.\r
637 </simpara>\r
638 </listitem>\r
639 </varlistentry>\r
640 <varlistentry>\r
641 <term>\r
642 --dense\r
643 </term>\r
644 <listitem>\r
645 <simpara>\r
646         Only the selected commits are shown, plus some to have a\r
647         meaningful history.\r
648 </simpara>\r
649 </listitem>\r
650 </varlistentry>\r
651 <varlistentry>\r
652 <term>\r
653 --sparse\r
654 </term>\r
655 <listitem>\r
656 <simpara>\r
657         All commits in the simplified history are shown.\r
658 </simpara>\r
659 </listitem>\r
660 </varlistentry>\r
661 <varlistentry>\r
662 <term>\r
663 --simplify-merges\r
664 </term>\r
665 <listitem>\r
666 <simpara>\r
667         Additional option to <emphasis>--full-history</emphasis> to remove some needless\r
668         merges from the resulting history, as there are no selected\r
669         commits contributing to this merge.\r
670 </simpara>\r
671 </listitem>\r
672 </varlistentry>\r
673 </variablelist>\r
674 <simpara>A more detailed explanation follows.</simpara>\r
675 <simpara>Suppose you specified <literal>foo</literal> as the &lt;paths&gt;.  We shall call commits\r
676 that modify <literal>foo</literal> !TREESAME, and the rest TREESAME.  (In a diff\r
677 filtered for <literal>foo</literal>, they look different and equal, respectively.)</simpara>\r
678 <simpara>In the following, we will always refer to the same example history to\r
679 illustrate the differences between simplification settings.  We assume\r
680 that you are filtering for a file <literal>foo</literal> in this commit graph:</simpara>\r
681 <literallayout>          .-A---M---N---O---P\r
682          /     /   /   /   /\r
683         I     B   C   D   E\r
684          \   /   /   /   /\r
685           `-------------'</literallayout>\r
686 <simpara>The horizontal line of history A&#8212;P is taken to be the first parent of\r
687 each merge.  The commits are:</simpara>\r
688 <itemizedlist>\r
689 <listitem>\r
690 <simpara>\r
691 <literal>I</literal> is the initial commit, in which <literal>foo</literal> exists with contents\r
692   "asdf", and a file <literal>quux</literal> exists with contents "quux".  Initial\r
693   commits are compared to an empty tree, so <literal>I</literal> is !TREESAME.\r
694 </simpara>\r
695 </listitem>\r
696 <listitem>\r
697 <simpara>\r
698 In <literal>A</literal>, <literal>foo</literal> contains just "foo".\r
699 </simpara>\r
700 </listitem>\r
701 <listitem>\r
702 <simpara>\r
703 <literal>B</literal> contains the same change as <literal>A</literal>.  Its merge <literal>M</literal> is trivial and\r
704   hence TREESAME to all parents.\r
705 </simpara>\r
706 </listitem>\r
707 <listitem>\r
708 <simpara>\r
709 <literal>C</literal> does not change <literal>foo</literal>, but its merge <literal>N</literal> changes it to "foobar",\r
710   so it is not TREESAME to any parent.\r
711 </simpara>\r
712 </listitem>\r
713 <listitem>\r
714 <simpara>\r
715 <literal>D</literal> sets <literal>foo</literal> to "baz".  Its merge <literal>O</literal> combines the strings from\r
716   <literal>N</literal> and <literal>D</literal> to "foobarbaz"; i.e., it is not TREESAME to any parent.\r
717 </simpara>\r
718 </listitem>\r
719 <listitem>\r
720 <simpara>\r
721 <literal>E</literal> changes <literal>quux</literal> to "xyzzy", and its merge <literal>P</literal> combines the\r
722   strings to "quux xyzzy".  Despite appearing interesting, <literal>P</literal> is\r
723   TREESAME to all parents.\r
724 </simpara>\r
725 </listitem>\r
726 </itemizedlist>\r
727 <simpara><emphasis>rev-list</emphasis> walks backwards through history, including or excluding\r
728 commits based on whether <emphasis>--full-history</emphasis> and/or parent rewriting\r
729 (via <emphasis>--parents</emphasis> or <emphasis>--children</emphasis>) are used.  The following settings\r
730 are available.</simpara>\r
731 <variablelist>\r
732 <varlistentry>\r
733 <term>\r
734 Default mode\r
735 </term>\r
736 <listitem>\r
737 <simpara>\r
738         Commits are included if they are not TREESAME to any parent\r
739         (though this can be changed, see <emphasis>--sparse</emphasis> below).  If the\r
740         commit was a merge, and it was TREESAME to one parent, follow\r
741         only that parent.  (Even if there are several TREESAME\r
742         parents, follow only one of them.)  Otherwise, follow all\r
743         parents.\r
744 </simpara>\r
745 <simpara>This results in:</simpara>\r
746 <literallayout>          .-A---N---O\r
747          /         /\r
748         I---------D</literallayout>\r
749 <simpara>Note how the rule to only follow the TREESAME parent, if one is\r
750 available, removed <literal>B</literal> from consideration entirely.  <literal>C</literal> was\r
751 considered via <literal>N</literal>, but is TREESAME.  Root commits are compared to an\r
752 empty tree, so <literal>I</literal> is !TREESAME.</simpara>\r
753 <simpara>Parent/child relations are only visible with --parents, but that does\r
754 not affect the commits selected in default mode, so we have shown the\r
755 parent lines.</simpara>\r
756 </listitem>\r
757 </varlistentry>\r
758 <varlistentry>\r
759 <term>\r
760 --full-history without parent rewriting\r
761 </term>\r
762 <listitem>\r
763 <simpara>\r
764         This mode differs from the default in one point: always follow\r
765         all parents of a merge, even if it is TREESAME to one of them.\r
766         Even if more than one side of the merge has commits that are\r
767         included, this does not imply that the merge itself is!  In\r
768         the example, we get\r
769 </simpara>\r
770 <literallayout>        I  A  B  N  D  O</literallayout>\r
771 <simpara><literal>P</literal> and <literal>M</literal> were excluded because they are TREESAME to a parent.  <literal>E</literal>,\r
772 <literal>C</literal> and <literal>B</literal> were all walked, but only <literal>B</literal> was !TREESAME, so the others\r
773 do not appear.</simpara>\r
774 <simpara>Note that without parent rewriting, it is not really possible to talk\r
775 about the parent/child relationships between the commits, so we show\r
776 them disconnected.</simpara>\r
777 </listitem>\r
778 </varlistentry>\r
779 <varlistentry>\r
780 <term>\r
781 --full-history with parent rewriting\r
782 </term>\r
783 <listitem>\r
784 <simpara>\r
785         Ordinary commits are only included if they are !TREESAME\r
786         (though this can be changed, see <emphasis>--sparse</emphasis> below).\r
787 </simpara>\r
788 <simpara>Merges are always included.  However, their parent list is rewritten:\r
789 Along each parent, prune away commits that are not included\r
790 themselves.  This results in</simpara>\r
791 <literallayout>          .-A---M---N---O---P\r
792          /     /   /   /   /\r
793         I     B   /   D   /\r
794          \   /   /   /   /\r
795           `-------------'</literallayout>\r
796 <simpara>Compare to <emphasis>--full-history</emphasis> without rewriting above.  Note that <literal>E</literal>\r
797 was pruned away because it is TREESAME, but the parent list of P was\r
798 rewritten to contain <literal>E</literal>'s parent <literal>I</literal>.  The same happened for <literal>C</literal> and\r
799 <literal>N</literal>.  Note also that <literal>P</literal> was included despite being TREESAME.</simpara>\r
800 </listitem>\r
801 </varlistentry>\r
802 </variablelist>\r
803 <simpara>In addition to the above settings, you can change whether TREESAME\r
804 affects inclusion:</simpara>\r
805 <variablelist>\r
806 <varlistentry>\r
807 <term>\r
808 --dense\r
809 </term>\r
810 <listitem>\r
811 <simpara>\r
812         Commits that are walked are included if they are not TREESAME\r
813         to any parent.\r
814 </simpara>\r
815 </listitem>\r
816 </varlistentry>\r
817 <varlistentry>\r
818 <term>\r
819 --sparse\r
820 </term>\r
821 <listitem>\r
822 <simpara>\r
823         All commits that are walked are included.\r
824 </simpara>\r
825 <simpara>Note that without <emphasis>--full-history</emphasis>, this still simplifies merges: if\r
826 one of the parents is TREESAME, we follow only that one, so the other\r
827 sides of the merge are never walked.</simpara>\r
828 </listitem>\r
829 </varlistentry>\r
830 </variablelist>\r
831 <simpara>Finally, there is a fourth simplification mode available:</simpara>\r
832 <variablelist>\r
833 <varlistentry>\r
834 <term>\r
835 --simplify-merges\r
836 </term>\r
837 <listitem>\r
838 <simpara>\r
839         First, build a history graph in the same way that\r
840         <emphasis>--full-history</emphasis> with parent rewriting does (see above).\r
841 </simpara>\r
842 <simpara>Then simplify each commit &#8216;C` to its replacement <literal>C&#8217;</literal> in the final\r
843 history according to the following rules:</simpara>\r
844 <itemizedlist>\r
845 <listitem>\r
846 <simpara>\r
847 Set &#8216;C&#8217;<literal> to `C</literal>.\r
848 </simpara>\r
849 </listitem>\r
850 <listitem>\r
851 <simpara>\r
852 Replace each parent &#8216;P` of <literal>C&#8217;</literal> with its simplification &#8216;P&#8217;`.  In\r
853   the process, drop parents that are ancestors of other parents, and\r
854   remove duplicates.\r
855 </simpara>\r
856 </listitem>\r
857 <listitem>\r
858 <simpara>\r
859 If after this parent rewriting, &#8216;C&#8217;` is a root or merge commit (has\r
860   zero or &gt;1 parents), a boundary commit, or !TREESAME, it remains.\r
861   Otherwise, it is replaced with its only parent.\r
862 </simpara>\r
863 </listitem>\r
864 </itemizedlist>\r
865 <simpara>The effect of this is best shown by way of comparing to\r
866 <emphasis>--full-history</emphasis> with parent rewriting.  The example turns into:</simpara>\r
867 <literallayout>          .-A---M---N---O\r
868          /     /       /\r
869         I     B       D\r
870          \   /       /\r
871           `---------'</literallayout>\r
872 <simpara>Note the major differences in <literal>N</literal> and <literal>P</literal> over <emphasis>--full-history</emphasis>:</simpara>\r
873 <itemizedlist>\r
874 <listitem>\r
875 <simpara>\r
876 <literal>N</literal>'s parent list had <literal>I</literal> removed, because it is an ancestor of the\r
877   other parent <literal>M</literal>.  Still, <literal>N</literal> remained because it is !TREESAME.\r
878 </simpara>\r
879 </listitem>\r
880 <listitem>\r
881 <simpara>\r
882 <literal>P</literal>'s parent list similarly had <literal>I</literal> removed.  <literal>P</literal> was then\r
883   removed completely, because it had one parent and is TREESAME.\r
884 </simpara>\r
885 </listitem>\r
886 </itemizedlist>\r
887 </listitem>\r
888 </varlistentry>\r
889 </variablelist>\r
890 <simpara>The <emphasis>--simplify-by-decoration</emphasis> option allows you to view only the\r
891 big picture of the topology of the history, by omitting commits\r
892 that are not referenced by tags.  Commits are marked as !TREESAME\r
893 (in other words, kept after history simplification rules described\r
894 above) if (1) they are referenced by tags, or (2) they change the\r
895 contents of the paths given on the command line.  All other\r
896 commits are marked as TREESAME (subject to be simplified away).</simpara>\r
897 </simplesect>\r
898 <simplesect id="_bisection_helpers">\r
899 <title>Bisection Helpers</title>\r
900 <variablelist>\r
901 <varlistentry>\r
902 <term>\r
903 --bisect\r
904 </term>\r
905 <listitem>\r
906 <simpara>\r
907 Limit output to the one commit object which is roughly halfway between\r
908 the included and excluded commits. Thus, if\r
909 </simpara>\r
910 </listitem>\r
911 </varlistentry>\r
912 </variablelist>\r
913 <literallayout>        $ git rev-list --bisect foo ^bar ^baz</literallayout>\r
914 <simpara>outputs <emphasis>midpoint</emphasis>, the output of the two commands</simpara>\r
915 <literallayout>        $ git rev-list foo ^midpoint\r
916         $ git rev-list midpoint ^bar ^baz</literallayout>\r
917 <simpara>would be of roughly the same length.  Finding the change which\r
918 introduces a regression is thus reduced to a binary search: repeatedly\r
919 generate and test new 'midpoint&#8217;s until the commit chain is of length\r
920 one.</simpara>\r
921 <variablelist>\r
922 <varlistentry>\r
923 <term>\r
924 --bisect-vars\r
925 </term>\r
926 <listitem>\r
927 <simpara>\r
928 This calculates the same as <literal>--bisect</literal>, but outputs text ready\r
929 to be eval&#8217;ed by the shell. These lines will assign the name of\r
930 the midpoint revision to the variable <literal>bisect_rev</literal>, and the\r
931 expected number of commits to be tested after <literal>bisect_rev</literal> is\r
932 tested to <literal>bisect_nr</literal>, the expected number of commits to be\r
933 tested if <literal>bisect_rev</literal> turns out to be good to <literal>bisect_good</literal>,\r
934 the expected number of commits to be tested if <literal>bisect_rev</literal>\r
935 turns out to be bad to <literal>bisect_bad</literal>, and the number of commits\r
936 we are bisecting right now to <literal>bisect_all</literal>.\r
937 </simpara>\r
938 </listitem>\r
939 </varlistentry>\r
940 <varlistentry>\r
941 <term>\r
942 --bisect-all\r
943 </term>\r
944 <listitem>\r
945 <simpara>\r
946 This outputs all the commit objects between the included and excluded\r
947 commits, ordered by their distance to the included and excluded\r
948 commits. The farthest from them is displayed first. (This is the only\r
949 one displayed by <literal>--bisect</literal>.)\r
950 </simpara>\r
951 </listitem>\r
952 </varlistentry>\r
953 </variablelist>\r
954 <simpara>This is useful because it makes it easy to choose a good commit to\r
955 test when you want to avoid to test some of them for some reason (they\r
956 may not compile for example).</simpara>\r
957 <simpara>This option can be used along with <literal>--bisect-vars</literal>, in this case,\r
958 after all the sorted commit objects, there will be the same text as if\r
959 <literal>--bisect-vars</literal> had been used alone.</simpara>\r
960 </simplesect>\r
961 <simplesect id="_commit_ordering">\r
962 <title>Commit Ordering</title>\r
963 <simpara>By default, the commits are shown in reverse chronological order.</simpara>\r
964 <variablelist>\r
965 <varlistentry>\r
966 <term>\r
967 --topo-order\r
968 </term>\r
969 <listitem>\r
970 <simpara>\r
971         This option makes them appear in topological order (i.e.\r
972         descendant commits are shown before their parents).\r
973 </simpara>\r
974 </listitem>\r
975 </varlistentry>\r
976 <varlistentry>\r
977 <term>\r
978 --date-order\r
979 </term>\r
980 <listitem>\r
981 <simpara>\r
982         This option is similar to <emphasis>--topo-order</emphasis> in the sense that no\r
983         parent comes before all of its children, but otherwise things\r
984         are still ordered in the commit timestamp order.\r
985 </simpara>\r
986 </listitem>\r
987 </varlistentry>\r
988 <varlistentry>\r
989 <term>\r
990 --reverse\r
991 </term>\r
992 <listitem>\r
993 <simpara>\r
994         Output the commits in reverse order.\r
995         Cannot be combined with <emphasis>--walk-reflogs</emphasis>.\r
996 </simpara>\r
997 </listitem>\r
998 </varlistentry>\r
999 </variablelist>\r
1000 </simplesect>\r
1001 <simplesect id="_object_traversal">\r
1002 <title>Object Traversal</title>\r
1003 <simpara>These options are mostly targeted for packing of git repositories.</simpara>\r
1004 <variablelist>\r
1005 <varlistentry>\r
1006 <term>\r
1007 --objects\r
1008 </term>\r
1009 <listitem>\r
1010 <simpara>\r
1011         Print the object IDs of any object referenced by the listed\r
1012         commits.  <emphasis>--objects foo ^bar</emphasis> thus means "send me\r
1013         all object IDs which I need to download if I have the commit\r
1014         object <emphasis>bar</emphasis>, but not <emphasis>foo</emphasis>".\r
1015 </simpara>\r
1016 </listitem>\r
1017 </varlistentry>\r
1018 <varlistentry>\r
1019 <term>\r
1020 --objects-edge\r
1021 </term>\r
1022 <listitem>\r
1023 <simpara>\r
1024         Similar to <emphasis>--objects</emphasis>, but also print the IDs of excluded\r
1025         commits prefixed with a "-" character.  This is used by\r
1026         <xref linkend="git-pack-objects(1)"/> to build "thin" pack, which records\r
1027         objects in deltified form based on objects contained in these\r
1028         excluded commits to reduce network traffic.\r
1029 </simpara>\r
1030 </listitem>\r
1031 </varlistentry>\r
1032 <varlistentry>\r
1033 <term>\r
1034 --unpacked\r
1035 </term>\r
1036 <listitem>\r
1037 <simpara>\r
1038         Only useful with <emphasis>--objects</emphasis>; print the object IDs that are not\r
1039         in packs.\r
1040 </simpara>\r
1041 </listitem>\r
1042 </varlistentry>\r
1043 <varlistentry>\r
1044 <term>\r
1045 --no-walk\r
1046 </term>\r
1047 <listitem>\r
1048 <simpara>\r
1049         Only show the given revs, but do not traverse their ancestors.\r
1050 </simpara>\r
1051 </listitem>\r
1052 </varlistentry>\r
1053 <varlistentry>\r
1054 <term>\r
1055 --do-walk\r
1056 </term>\r
1057 <listitem>\r
1058 <simpara>\r
1059         Overrides a previous --no-walk.\r
1060 </simpara>\r
1061 </listitem>\r
1062 </varlistentry>\r
1063 </variablelist>\r
1064 </simplesect>\r
1065 </simplesect>\r
1066 <simplesect id="_pretty_formats">\r
1067 <title>PRETTY FORMATS</title>\r
1068 <simpara>If the commit is a merge, and if the pretty-format\r
1069 is not <emphasis>oneline</emphasis>, <emphasis>email</emphasis> or <emphasis>raw</emphasis>, an additional line is\r
1070 inserted before the <emphasis>Author:</emphasis> line.  This line begins with\r
1071 "Merge: " and the sha1s of ancestral commits are printed,\r
1072 separated by spaces.  Note that the listed commits may not\r
1073 necessarily be the list of the <emphasis role="strong">direct</emphasis> parent commits if you\r
1074 have limited your view of history: for example, if you are\r
1075 only interested in changes related to a certain directory or\r
1076 file.</simpara>\r
1077 <simpara>Here are some additional details for each format:</simpara>\r
1078 <itemizedlist>\r
1079 <listitem>\r
1080 <simpara>\r
1081 <emphasis>oneline</emphasis>\r
1082 </simpara>\r
1083 <literallayout class="monospaced">&lt;sha1&gt; &lt;title line&gt;</literallayout>\r
1084 <simpara>This is designed to be as compact as possible.</simpara>\r
1085 </listitem>\r
1086 <listitem>\r
1087 <simpara>\r
1088 <emphasis>short</emphasis>\r
1089 </simpara>\r
1090 <literallayout class="monospaced">commit &lt;sha1&gt;\r
1091 Author: &lt;author&gt;</literallayout>\r
1092 <literallayout class="monospaced">&lt;title line&gt;</literallayout>\r
1093 </listitem>\r
1094 <listitem>\r
1095 <simpara>\r
1096 <emphasis>medium</emphasis>\r
1097 </simpara>\r
1098 <literallayout class="monospaced">commit &lt;sha1&gt;\r
1099 Author: &lt;author&gt;\r
1100 Date:   &lt;author date&gt;</literallayout>\r
1101 <literallayout class="monospaced">&lt;title line&gt;</literallayout>\r
1102 <literallayout class="monospaced">&lt;full commit message&gt;</literallayout>\r
1103 </listitem>\r
1104 <listitem>\r
1105 <simpara>\r
1106 <emphasis>full</emphasis>\r
1107 </simpara>\r
1108 <literallayout class="monospaced">commit &lt;sha1&gt;\r
1109 Author: &lt;author&gt;\r
1110 Commit: &lt;committer&gt;</literallayout>\r
1111 <literallayout class="monospaced">&lt;title line&gt;</literallayout>\r
1112 <literallayout class="monospaced">&lt;full commit message&gt;</literallayout>\r
1113 </listitem>\r
1114 <listitem>\r
1115 <simpara>\r
1116 <emphasis>fuller</emphasis>\r
1117 </simpara>\r
1118 <literallayout class="monospaced">commit &lt;sha1&gt;\r
1119 Author:     &lt;author&gt;\r
1120 AuthorDate: &lt;author date&gt;\r
1121 Commit:     &lt;committer&gt;\r
1122 CommitDate: &lt;committer date&gt;</literallayout>\r
1123 <literallayout class="monospaced">&lt;title line&gt;</literallayout>\r
1124 <literallayout class="monospaced">&lt;full commit message&gt;</literallayout>\r
1125 </listitem>\r
1126 <listitem>\r
1127 <simpara>\r
1128 <emphasis>email</emphasis>\r
1129 </simpara>\r
1130 <literallayout class="monospaced">From &lt;sha1&gt; &lt;date&gt;\r
1131 From: &lt;author&gt;\r
1132 Date: &lt;author date&gt;\r
1133 Subject: [PATCH] &lt;title line&gt;</literallayout>\r
1134 <literallayout class="monospaced">&lt;full commit message&gt;</literallayout>\r
1135 </listitem>\r
1136 <listitem>\r
1137 <simpara>\r
1138 <emphasis>raw</emphasis>\r
1139 </simpara>\r
1140 <simpara>The <emphasis>raw</emphasis> format shows the entire commit exactly as\r
1141 stored in the commit object.  Notably, the SHA1s are\r
1142 displayed in full, regardless of whether --abbrev or\r
1143 --no-abbrev are used, and <emphasis>parents</emphasis> information show the\r
1144 true parent commits, without taking grafts nor history\r
1145 simplification into account.</simpara>\r
1146 </listitem>\r
1147 <listitem>\r
1148 <simpara>\r
1149 <emphasis>format:</emphasis>\r
1150 </simpara>\r
1151 <simpara>The <emphasis>format:</emphasis> format allows you to specify which information\r
1152 you want to show. It works a little bit like printf format,\r
1153 with the notable exception that you get a newline with <emphasis>%n</emphasis>\r
1154 instead of <emphasis>\n</emphasis>.</simpara>\r
1155 <simpara>E.g, <emphasis>format:"The author of %h was %an, %ar%nThe title was &gt;&gt;%s&lt;&lt;%n"</emphasis>\r
1156 would show something like this:</simpara>\r
1157 <literallayout>The author of fe6e0ee was Junio C Hamano, 23 hours ago\r
1158 The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;</literallayout>\r
1159 <simpara>The placeholders are:</simpara>\r
1160 <itemizedlist>\r
1161 <listitem>\r
1162 <simpara>\r
1163 <emphasis>%H</emphasis>: commit hash\r
1164 </simpara>\r
1165 </listitem>\r
1166 <listitem>\r
1167 <simpara>\r
1168 <emphasis>%h</emphasis>: abbreviated commit hash\r
1169 </simpara>\r
1170 </listitem>\r
1171 <listitem>\r
1172 <simpara>\r
1173 <emphasis>%T</emphasis>: tree hash\r
1174 </simpara>\r
1175 </listitem>\r
1176 <listitem>\r
1177 <simpara>\r
1178 <emphasis>%t</emphasis>: abbreviated tree hash\r
1179 </simpara>\r
1180 </listitem>\r
1181 <listitem>\r
1182 <simpara>\r
1183 <emphasis>%P</emphasis>: parent hashes\r
1184 </simpara>\r
1185 </listitem>\r
1186 <listitem>\r
1187 <simpara>\r
1188 <emphasis>%p</emphasis>: abbreviated parent hashes\r
1189 </simpara>\r
1190 </listitem>\r
1191 <listitem>\r
1192 <simpara>\r
1193 <emphasis>%an</emphasis>: author name\r
1194 </simpara>\r
1195 </listitem>\r
1196 <listitem>\r
1197 <simpara>\r
1198 <emphasis>%aN</emphasis>: author name (respecting .mailmap)\r
1199 </simpara>\r
1200 </listitem>\r
1201 <listitem>\r
1202 <simpara>\r
1203 <emphasis>%ae</emphasis>: author email\r
1204 </simpara>\r
1205 </listitem>\r
1206 <listitem>\r
1207 <simpara>\r
1208 <emphasis>%aE</emphasis>: author email (respecting .mailmap)\r
1209 </simpara>\r
1210 </listitem>\r
1211 <listitem>\r
1212 <simpara>\r
1213 <emphasis>%ad</emphasis>: author date (format respects --date= option)\r
1214 </simpara>\r
1215 </listitem>\r
1216 <listitem>\r
1217 <simpara>\r
1218 <emphasis>%aD</emphasis>: author date, RFC2822 style\r
1219 </simpara>\r
1220 </listitem>\r
1221 <listitem>\r
1222 <simpara>\r
1223 <emphasis>%ar</emphasis>: author date, relative\r
1224 </simpara>\r
1225 </listitem>\r
1226 <listitem>\r
1227 <simpara>\r
1228 <emphasis>%at</emphasis>: author date, UNIX timestamp\r
1229 </simpara>\r
1230 </listitem>\r
1231 <listitem>\r
1232 <simpara>\r
1233 <emphasis>%ai</emphasis>: author date, ISO 8601 format\r
1234 </simpara>\r
1235 </listitem>\r
1236 <listitem>\r
1237 <simpara>\r
1238 <emphasis>%cn</emphasis>: committer name\r
1239 </simpara>\r
1240 </listitem>\r
1241 <listitem>\r
1242 <simpara>\r
1243 <emphasis>%cN</emphasis>: committer name (respecting .mailmap)\r
1244 </simpara>\r
1245 </listitem>\r
1246 <listitem>\r
1247 <simpara>\r
1248 <emphasis>%ce</emphasis>: committer email\r
1249 </simpara>\r
1250 </listitem>\r
1251 <listitem>\r
1252 <simpara>\r
1253 <emphasis>%cE</emphasis>: committer email (respecting .mailmap)\r
1254 </simpara>\r
1255 </listitem>\r
1256 <listitem>\r
1257 <simpara>\r
1258 <emphasis>%cd</emphasis>: committer date\r
1259 </simpara>\r
1260 </listitem>\r
1261 <listitem>\r
1262 <simpara>\r
1263 <emphasis>%cD</emphasis>: committer date, RFC2822 style\r
1264 </simpara>\r
1265 </listitem>\r
1266 <listitem>\r
1267 <simpara>\r
1268 <emphasis>%cr</emphasis>: committer date, relative\r
1269 </simpara>\r
1270 </listitem>\r
1271 <listitem>\r
1272 <simpara>\r
1273 <emphasis>%ct</emphasis>: committer date, UNIX timestamp\r
1274 </simpara>\r
1275 </listitem>\r
1276 <listitem>\r
1277 <simpara>\r
1278 <emphasis>%ci</emphasis>: committer date, ISO 8601 format\r
1279 </simpara>\r
1280 </listitem>\r
1281 <listitem>\r
1282 <simpara>\r
1283 <emphasis>%d</emphasis>: ref names, like the --decorate option of <xref linkend="git-log(1)"/>\r
1284 </simpara>\r
1285 </listitem>\r
1286 <listitem>\r
1287 <simpara>\r
1288 <emphasis>%e</emphasis>: encoding\r
1289 </simpara>\r
1290 </listitem>\r
1291 <listitem>\r
1292 <simpara>\r
1293 <emphasis>%s</emphasis>: subject\r
1294 </simpara>\r
1295 </listitem>\r
1296 <listitem>\r
1297 <simpara>\r
1298 <emphasis>%b</emphasis>: body\r
1299 </simpara>\r
1300 </listitem>\r
1301 <listitem>\r
1302 <simpara>\r
1303 <emphasis>%Cred</emphasis>: switch color to red\r
1304 </simpara>\r
1305 </listitem>\r
1306 <listitem>\r
1307 <simpara>\r
1308 <emphasis>%Cgreen</emphasis>: switch color to green\r
1309 </simpara>\r
1310 </listitem>\r
1311 <listitem>\r
1312 <simpara>\r
1313 <emphasis>%Cblue</emphasis>: switch color to blue\r
1314 </simpara>\r
1315 </listitem>\r
1316 <listitem>\r
1317 <simpara>\r
1318 <emphasis>%Creset</emphasis>: reset color\r
1319 </simpara>\r
1320 </listitem>\r
1321 <listitem>\r
1322 <simpara>\r
1323 <emphasis>%C(&#8230;)</emphasis>: color specification, as described in color.branch.* config option\r
1324 </simpara>\r
1325 </listitem>\r
1326 <listitem>\r
1327 <simpara>\r
1328 <emphasis>%m</emphasis>: left, right or boundary mark\r
1329 </simpara>\r
1330 </listitem>\r
1331 <listitem>\r
1332 <simpara>\r
1333 <emphasis>%n</emphasis>: newline\r
1334 </simpara>\r
1335 </listitem>\r
1336 <listitem>\r
1337 <simpara>\r
1338 <emphasis>%x00</emphasis>: print a byte from a hex code\r
1339 </simpara>\r
1340 </listitem>\r
1341 </itemizedlist>\r
1342 </listitem>\r
1343 <listitem>\r
1344 <simpara>\r
1345 <emphasis>tformat:</emphasis>\r
1346 </simpara>\r
1347 <simpara>The <emphasis>tformat:</emphasis> format works exactly like <emphasis>format:</emphasis>, except that it\r
1348 provides "terminator" semantics instead of "separator" semantics. In\r
1349 other words, each commit has the message terminator character (usually a\r
1350 newline) appended, rather than a separator placed between entries.\r
1351 This means that the final entry of a single-line format will be properly\r
1352 terminated with a new line, just as the "oneline" format does.\r
1353 For example:</simpara>\r
1354 <literallayout>$ git log -2 --pretty=format:%h 4da45bef \\r
1355   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'\r
1356 4da45be\r
1357 7134973 -- NO NEWLINE\r
1358 \r
1359 $ git log -2 --pretty=tformat:%h 4da45bef \\r
1360   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'\r
1361 4da45be\r
1362 7134973</literallayout>\r
1363 </listitem>\r
1364 </itemizedlist>\r
1365 </simplesect>\r
1366 <simplesect id="_author">\r
1367 <title>Author</title>\r
1368 <simpara>Written by Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt;</simpara>\r
1369 </simplesect>\r
1370 <simplesect id="_documentation">\r
1371 <title>Documentation</title>\r
1372 <simpara>Documentation by David Greaves, Junio C Hamano, Jonas Fonseca\r
1373 and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
1374 </simplesect>\r
1375 <simplesect id="_git">\r
1376 <title>GIT</title>\r
1377 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
1378 </simplesect>\r
1379 </article>\r