OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-log.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-log(1)">\r
5 <articleinfo>\r
6     <title>git-log(1)</title>\r
7         <indexterm>\r
8                 <primary>git-log(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-log - Show commit logs</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <simpara><emphasis>git log</emphasis> [&lt;options&gt;] [&lt;since&gt;..&lt;until&gt;] [[--] &lt;path&gt;&#8230;]</simpara>\r
18 </simplesect>\r
19 <simplesect id="_description">\r
20 <title>DESCRIPTION</title>\r
21 <simpara>Shows the commit logs.</simpara>\r
22 <simpara>The command takes options applicable to the <emphasis>git-rev-list</emphasis>\r
23 command to control what is shown and how, and options applicable to\r
24 the <emphasis>git-diff-*</emphasis> commands to control how the changes\r
25 each commit introduces are shown.</simpara>\r
26 </simplesect>\r
27 <simplesect id="_options">\r
28 <title>OPTIONS</title>\r
29 <variablelist>\r
30 <varlistentry>\r
31 <term>\r
32 -p\r
33 </term>\r
34 <term>\r
35 -u\r
36 </term>\r
37 <listitem>\r
38 <simpara>\r
39         Generate patch (see section on generating patches).\r
40         \r
41 </simpara>\r
42 </listitem>\r
43 </varlistentry>\r
44 <varlistentry>\r
45 <term>\r
46 -U&lt;n&gt;\r
47 </term>\r
48 <term>\r
49 --unified=&lt;n&gt;\r
50 </term>\r
51 <listitem>\r
52 <simpara>\r
53         Generate diffs with &lt;n&gt; lines of context instead of\r
54         the usual three. Implies "-p".\r
55 </simpara>\r
56 </listitem>\r
57 </varlistentry>\r
58 <varlistentry>\r
59 <term>\r
60 --raw\r
61 </term>\r
62 <listitem>\r
63 <simpara>\r
64         Generate the raw format.\r
65         \r
66 </simpara>\r
67 </listitem>\r
68 </varlistentry>\r
69 <varlistentry>\r
70 <term>\r
71 --patch-with-raw\r
72 </term>\r
73 <listitem>\r
74 <simpara>\r
75         Synonym for "-p --raw".\r
76 </simpara>\r
77 </listitem>\r
78 </varlistentry>\r
79 <varlistentry>\r
80 <term>\r
81 --patience\r
82 </term>\r
83 <listitem>\r
84 <simpara>\r
85         Generate a diff using the "patience diff" algorithm.\r
86 </simpara>\r
87 </listitem>\r
88 </varlistentry>\r
89 <varlistentry>\r
90 <term>\r
91 --stat[=width[,name-width]]\r
92 </term>\r
93 <listitem>\r
94 <simpara>\r
95         Generate a diffstat.  You can override the default\r
96         output width for 80-column terminal by "--stat=width".\r
97         The width of the filename part can be controlled by\r
98         giving another width to it separated by a comma.\r
99 </simpara>\r
100 </listitem>\r
101 </varlistentry>\r
102 <varlistentry>\r
103 <term>\r
104 --numstat\r
105 </term>\r
106 <listitem>\r
107 <simpara>\r
108         Similar to --stat, but shows number of added and\r
109         deleted lines in decimal notation and pathname without\r
110         abbreviation, to make it more machine friendly.  For\r
111         binary files, outputs two <literal>-</literal> instead of saying\r
112         <literal>0 0</literal>.\r
113 </simpara>\r
114 </listitem>\r
115 </varlistentry>\r
116 <varlistentry>\r
117 <term>\r
118 --shortstat\r
119 </term>\r
120 <listitem>\r
121 <simpara>\r
122         Output only the last line of the --stat format containing total\r
123         number of modified files, as well as number of added and deleted\r
124         lines.\r
125 </simpara>\r
126 </listitem>\r
127 </varlistentry>\r
128 <varlistentry>\r
129 <term>\r
130 --dirstat[=limit]\r
131 </term>\r
132 <listitem>\r
133 <simpara>\r
134         Output the distribution of relative amount of changes (number of lines added or\r
135         removed) for each sub-directory. Directories with changes below\r
136         a cut-off percent (3% by default) are not shown. The cut-off percent\r
137         can be set with "--dirstat=limit". Changes in a child directory is not\r
138         counted for the parent directory, unless "--cumulative" is used.\r
139 </simpara>\r
140 </listitem>\r
141 </varlistentry>\r
142 <varlistentry>\r
143 <term>\r
144 --dirstat-by-file[=limit]\r
145 </term>\r
146 <listitem>\r
147 <simpara>\r
148         Same as --dirstat, but counts changed files instead of lines.\r
149 </simpara>\r
150 </listitem>\r
151 </varlistentry>\r
152 <varlistentry>\r
153 <term>\r
154 --summary\r
155 </term>\r
156 <listitem>\r
157 <simpara>\r
158         Output a condensed summary of extended header information\r
159         such as creations, renames and mode changes.\r
160 </simpara>\r
161 </listitem>\r
162 </varlistentry>\r
163 <varlistentry>\r
164 <term>\r
165 --patch-with-stat\r
166 </term>\r
167 <listitem>\r
168 <simpara>\r
169         Synonym for "-p --stat".\r
170         \r
171 </simpara>\r
172 </listitem>\r
173 </varlistentry>\r
174 <varlistentry>\r
175 <term>\r
176 -z\r
177 </term>\r
178 <listitem>\r
179 <simpara>\r
180         NUL-line termination on output.  This affects the --raw\r
181         output field terminator.  Also output from commands such\r
182         as "git-log" will be delimited with NUL between commits.\r
183 </simpara>\r
184 </listitem>\r
185 </varlistentry>\r
186 <varlistentry>\r
187 <term>\r
188 --name-only\r
189 </term>\r
190 <listitem>\r
191 <simpara>\r
192         Show only names of changed files.\r
193 </simpara>\r
194 </listitem>\r
195 </varlistentry>\r
196 <varlistentry>\r
197 <term>\r
198 --name-status\r
199 </term>\r
200 <listitem>\r
201 <simpara>\r
202         Show only names and status of changed files. See the description\r
203         of the <literal>--diff-filter</literal> option on what the status letters mean.\r
204 </simpara>\r
205 </listitem>\r
206 </varlistentry>\r
207 <varlistentry>\r
208 <term>\r
209 --color\r
210 </term>\r
211 <listitem>\r
212 <simpara>\r
213         Show colored diff.\r
214 </simpara>\r
215 </listitem>\r
216 </varlistentry>\r
217 <varlistentry>\r
218 <term>\r
219 --no-color\r
220 </term>\r
221 <listitem>\r
222 <simpara>\r
223         Turn off colored diff, even when the configuration file\r
224         gives the default to color output.\r
225 </simpara>\r
226 </listitem>\r
227 </varlistentry>\r
228 <varlistentry>\r
229 <term>\r
230 --color-words[=&lt;regex&gt;]\r
231 </term>\r
232 <listitem>\r
233 <simpara>\r
234         Show colored word diff, i.e., color words which have changed.\r
235         By default, words are separated by whitespace.\r
236 </simpara>\r
237 <simpara>When a &lt;regex&gt; is specified, every non-overlapping match of the\r
238 &lt;regex&gt; is considered a word.  Anything between these matches is\r
239 considered whitespace and ignored(!) for the purposes of finding\r
240 differences.  You may want to append <literal>|[^[:space:]]</literal> to your regular\r
241 expression to make sure that it matches all non-whitespace characters.\r
242 A match that contains a newline is silently truncated(!) at the\r
243 newline.</simpara>\r
244 <simpara>The regex can also be set via a diff driver or configuration option, see\r
245 <xref linkend="gitattributes(1)"/> or <xref linkend="git-config(1)"/>.  Giving it explicitly\r
246 overrides any diff driver or configuration setting.  Diff drivers\r
247 override configuration settings.</simpara>\r
248 </listitem>\r
249 </varlistentry>\r
250 <varlistentry>\r
251 <term>\r
252 --no-renames\r
253 </term>\r
254 <listitem>\r
255 <simpara>\r
256         Turn off rename detection, even when the configuration\r
257         file gives the default to do so.\r
258 </simpara>\r
259 </listitem>\r
260 </varlistentry>\r
261 <varlistentry>\r
262 <term>\r
263 --check\r
264 </term>\r
265 <listitem>\r
266 <simpara>\r
267         Warn if changes introduce trailing whitespace\r
268         or an indent that uses a space before a tab. Exits with\r
269         non-zero status if problems are found. Not compatible with\r
270         --exit-code.\r
271 </simpara>\r
272 </listitem>\r
273 </varlistentry>\r
274 <varlistentry>\r
275 <term>\r
276 --full-index\r
277 </term>\r
278 <listitem>\r
279 <simpara>\r
280         Instead of the first handful of characters, show the full\r
281         pre- and post-image blob object names on the "index"\r
282         line when generating patch format output.\r
283 </simpara>\r
284 </listitem>\r
285 </varlistentry>\r
286 <varlistentry>\r
287 <term>\r
288 --binary\r
289 </term>\r
290 <listitem>\r
291 <simpara>\r
292         In addition to --full-index, output "binary diff" that\r
293         can be applied with "git apply".\r
294 </simpara>\r
295 </listitem>\r
296 </varlistentry>\r
297 <varlistentry>\r
298 <term>\r
299 --abbrev[=&lt;n&gt;]\r
300 </term>\r
301 <listitem>\r
302 <simpara>\r
303         Instead of showing the full 40-byte hexadecimal object\r
304         name in diff-raw format output and diff-tree header\r
305         lines, show only a partial prefix.  This is\r
306         independent of --full-index option above, which controls\r
307         the diff-patch output format.  Non default number of\r
308         digits can be specified with --abbrev=&lt;n&gt;.\r
309 </simpara>\r
310 </listitem>\r
311 </varlistentry>\r
312 <varlistentry>\r
313 <term>\r
314 -B\r
315 </term>\r
316 <listitem>\r
317 <simpara>\r
318         Break complete rewrite changes into pairs of delete and create.\r
319 </simpara>\r
320 </listitem>\r
321 </varlistentry>\r
322 <varlistentry>\r
323 <term>\r
324 -M\r
325 </term>\r
326 <listitem>\r
327 <simpara>\r
328         Detect renames.\r
329 </simpara>\r
330 </listitem>\r
331 </varlistentry>\r
332 <varlistentry>\r
333 <term>\r
334 -C\r
335 </term>\r
336 <listitem>\r
337 <simpara>\r
338         Detect copies as well as renames.  See also <literal>--find-copies-harder</literal>.\r
339 </simpara>\r
340 </listitem>\r
341 </varlistentry>\r
342 <varlistentry>\r
343 <term>\r
344 --diff-filter=[ACDMRTUXB*]\r
345 </term>\r
346 <listitem>\r
347 <simpara>\r
348         Select only files that are Added (<literal>A</literal>), Copied (<literal>C</literal>),\r
349         Deleted (<literal>D</literal>), Modified (<literal>M</literal>), Renamed (<literal>R</literal>), have their\r
350         type (i.e. regular file, symlink, submodule, &#8230;) changed (<literal>T</literal>),\r
351         are Unmerged (<literal>U</literal>), are\r
352         Unknown (<literal>X</literal>), or have had their pairing Broken (<literal>B</literal>).\r
353         Any combination of the filter characters may be used.\r
354         When <literal>*</literal> (All-or-none) is added to the combination, all\r
355         paths are selected if there is any file that matches\r
356         other criteria in the comparison; if there is no file\r
357         that matches other criteria, nothing is selected.\r
358 </simpara>\r
359 </listitem>\r
360 </varlistentry>\r
361 <varlistentry>\r
362 <term>\r
363 --find-copies-harder\r
364 </term>\r
365 <listitem>\r
366 <simpara>\r
367         For performance reasons, by default, <literal>-C</literal> option finds copies only\r
368         if the original file of the copy was modified in the same\r
369         changeset.  This flag makes the command\r
370         inspect unmodified files as candidates for the source of\r
371         copy.  This is a very expensive operation for large\r
372         projects, so use it with caution.  Giving more than one\r
373         <literal>-C</literal> option has the same effect.\r
374 </simpara>\r
375 </listitem>\r
376 </varlistentry>\r
377 <varlistentry>\r
378 <term>\r
379 -l&lt;num&gt;\r
380 </term>\r
381 <listitem>\r
382 <simpara>\r
383         -M and -C options require O(n^2) processing time where n\r
384         is the number of potential rename/copy targets.  This\r
385         option prevents rename/copy detection from running if\r
386         the number of rename/copy targets exceeds the specified\r
387         number.\r
388 </simpara>\r
389 </listitem>\r
390 </varlistentry>\r
391 <varlistentry>\r
392 <term>\r
393 -S&lt;string&gt;\r
394 </term>\r
395 <listitem>\r
396 <simpara>\r
397         Look for differences that contain the change in &lt;string&gt;.\r
398 </simpara>\r
399 </listitem>\r
400 </varlistentry>\r
401 <varlistentry>\r
402 <term>\r
403 --pickaxe-all\r
404 </term>\r
405 <listitem>\r
406 <simpara>\r
407         When -S finds a change, show all the changes in that\r
408         changeset, not just the files that contain the change\r
409         in &lt;string&gt;.\r
410 </simpara>\r
411 </listitem>\r
412 </varlistentry>\r
413 <varlistentry>\r
414 <term>\r
415 --pickaxe-regex\r
416 </term>\r
417 <listitem>\r
418 <simpara>\r
419         Make the &lt;string&gt; not a plain string but an extended POSIX\r
420         regex to match.\r
421 </simpara>\r
422 </listitem>\r
423 </varlistentry>\r
424 <varlistentry>\r
425 <term>\r
426 -O&lt;orderfile&gt;\r
427 </term>\r
428 <listitem>\r
429 <simpara>\r
430         Output the patch in the order specified in the\r
431         &lt;orderfile&gt;, which has one shell glob pattern per line.\r
432 </simpara>\r
433 </listitem>\r
434 </varlistentry>\r
435 <varlistentry>\r
436 <term>\r
437 -R\r
438 </term>\r
439 <listitem>\r
440 <simpara>\r
441         Swap two inputs; that is, show differences from index or\r
442         on-disk file to tree contents.\r
443 </simpara>\r
444 </listitem>\r
445 </varlistentry>\r
446 <varlistentry>\r
447 <term>\r
448 --relative[=&lt;path&gt;]\r
449 </term>\r
450 <listitem>\r
451 <simpara>\r
452         When run from a subdirectory of the project, it can be\r
453         told to exclude changes outside the directory and show\r
454         pathnames relative to it with this option.  When you are\r
455         not in a subdirectory (e.g. in a bare repository), you\r
456         can name which subdirectory to make the output relative\r
457         to by giving a &lt;path&gt; as an argument.\r
458 </simpara>\r
459 </listitem>\r
460 </varlistentry>\r
461 <varlistentry>\r
462 <term>\r
463 -a\r
464 </term>\r
465 <term>\r
466 --text\r
467 </term>\r
468 <listitem>\r
469 <simpara>\r
470         Treat all files as text.\r
471 </simpara>\r
472 </listitem>\r
473 </varlistentry>\r
474 <varlistentry>\r
475 <term>\r
476 --ignore-space-at-eol\r
477 </term>\r
478 <listitem>\r
479 <simpara>\r
480         Ignore changes in whitespace at EOL.\r
481 </simpara>\r
482 </listitem>\r
483 </varlistentry>\r
484 <varlistentry>\r
485 <term>\r
486 -b\r
487 </term>\r
488 <term>\r
489 --ignore-space-change\r
490 </term>\r
491 <listitem>\r
492 <simpara>\r
493         Ignore changes in amount of whitespace.  This ignores whitespace\r
494         at line end, and considers all other sequences of one or\r
495         more whitespace characters to be equivalent.\r
496 </simpara>\r
497 </listitem>\r
498 </varlistentry>\r
499 <varlistentry>\r
500 <term>\r
501 -w\r
502 </term>\r
503 <term>\r
504 --ignore-all-space\r
505 </term>\r
506 <listitem>\r
507 <simpara>\r
508         Ignore whitespace when comparing lines.  This ignores\r
509         differences even if one line has whitespace where the other\r
510         line has none.\r
511 </simpara>\r
512 </listitem>\r
513 </varlistentry>\r
514 <varlistentry>\r
515 <term>\r
516 --inter-hunk-context=&lt;lines&gt;\r
517 </term>\r
518 <listitem>\r
519 <simpara>\r
520         Show the context between diff hunks, up to the specified number\r
521         of lines, thereby fusing hunks that are close to each other.\r
522 </simpara>\r
523 </listitem>\r
524 </varlistentry>\r
525 <varlistentry>\r
526 <term>\r
527 --exit-code\r
528 </term>\r
529 <listitem>\r
530 <simpara>\r
531         Make the program exit with codes similar to diff(1).\r
532         That is, it exits with 1 if there were differences and\r
533         0 means no differences.\r
534 </simpara>\r
535 </listitem>\r
536 </varlistentry>\r
537 <varlistentry>\r
538 <term>\r
539 --quiet\r
540 </term>\r
541 <listitem>\r
542 <simpara>\r
543         Disable all output of the program. Implies --exit-code.\r
544 </simpara>\r
545 </listitem>\r
546 </varlistentry>\r
547 <varlistentry>\r
548 <term>\r
549 --ext-diff\r
550 </term>\r
551 <listitem>\r
552 <simpara>\r
553         Allow an external diff helper to be executed. If you set an\r
554         external diff driver with <xref linkend="gitattributes(5)"/>, you need\r
555         to use this option with <xref linkend="git-log(1)"/> and friends.\r
556 </simpara>\r
557 </listitem>\r
558 </varlistentry>\r
559 <varlistentry>\r
560 <term>\r
561 --no-ext-diff\r
562 </term>\r
563 <listitem>\r
564 <simpara>\r
565         Disallow external diff drivers.\r
566 </simpara>\r
567 </listitem>\r
568 </varlistentry>\r
569 <varlistentry>\r
570 <term>\r
571 --ignore-submodules\r
572 </term>\r
573 <listitem>\r
574 <simpara>\r
575         Ignore changes to submodules in the diff generation.\r
576 </simpara>\r
577 </listitem>\r
578 </varlistentry>\r
579 <varlistentry>\r
580 <term>\r
581 --src-prefix=&lt;prefix&gt;\r
582 </term>\r
583 <listitem>\r
584 <simpara>\r
585         Show the given source prefix instead of "a/".\r
586 </simpara>\r
587 </listitem>\r
588 </varlistentry>\r
589 <varlistentry>\r
590 <term>\r
591 --dst-prefix=&lt;prefix&gt;\r
592 </term>\r
593 <listitem>\r
594 <simpara>\r
595         Show the given destination prefix instead of "b/".\r
596 </simpara>\r
597 </listitem>\r
598 </varlistentry>\r
599 <varlistentry>\r
600 <term>\r
601 --no-prefix\r
602 </term>\r
603 <listitem>\r
604 <simpara>\r
605         Do not show any source or destination prefix.\r
606 </simpara>\r
607 </listitem>\r
608 </varlistentry>\r
609 </variablelist>\r
610 <simpara>For more detailed explanation on these common options, see also\r
611 <xref linkend="gitdiffcore(7)"/>.</simpara>\r
612 <variablelist>\r
613 <varlistentry>\r
614 <term>\r
615 -&lt;n&gt;\r
616 </term>\r
617 <listitem>\r
618 <simpara>\r
619         Limits the number of commits to show.\r
620 </simpara>\r
621 </listitem>\r
622 </varlistentry>\r
623 <varlistentry>\r
624 <term>\r
625 &lt;since&gt;..&lt;until&gt;\r
626 </term>\r
627 <listitem>\r
628 <simpara>\r
629         Show only commits between the named two commits.  When\r
630         either &lt;since&gt; or &lt;until&gt; is omitted, it defaults to\r
631         <literal>HEAD</literal>, i.e. the tip of the current branch.\r
632         For a more complete list of ways to spell &lt;since&gt;\r
633         and &lt;until&gt;, see "SPECIFYING REVISIONS" section in\r
634         <xref linkend="git-rev-parse(1)"/>.\r
635 </simpara>\r
636 </listitem>\r
637 </varlistentry>\r
638 <varlistentry>\r
639 <term>\r
640 --decorate\r
641 </term>\r
642 <listitem>\r
643 <simpara>\r
644         Print out the ref names of any commits that are shown.\r
645 </simpara>\r
646 </listitem>\r
647 </varlistentry>\r
648 <varlistentry>\r
649 <term>\r
650 --source\r
651 </term>\r
652 <listitem>\r
653 <simpara>\r
654         Print out the ref name given on the command line by which each\r
655         commit was reached.\r
656 </simpara>\r
657 </listitem>\r
658 </varlistentry>\r
659 <varlistentry>\r
660 <term>\r
661 --full-diff\r
662 </term>\r
663 <listitem>\r
664 <simpara>\r
665         Without this flag, "git log -p &lt;path&gt;&#8230;" shows commits that\r
666         touch the specified paths, and diffs about the same specified\r
667         paths.  With this, the full diff is shown for commits that touch\r
668         the specified paths; this means that "&lt;path&gt;&#8230;" limits only\r
669         commits, and doesn&#8217;t limit diff for those commits.\r
670 </simpara>\r
671 </listitem>\r
672 </varlistentry>\r
673 <varlistentry>\r
674 <term>\r
675 --follow\r
676 </term>\r
677 <listitem>\r
678 <simpara>\r
679         Continue listing the history of a file beyond renames.\r
680 </simpara>\r
681 </listitem>\r
682 </varlistentry>\r
683 <varlistentry>\r
684 <term>\r
685 --log-size\r
686 </term>\r
687 <listitem>\r
688 <simpara>\r
689         Before the log message print out its size in bytes. Intended\r
690         mainly for porcelain tools consumption. If git is unable to\r
691         produce a valid value size is set to zero.\r
692         Note that only message is considered, if also a diff is shown\r
693         its size is not included.\r
694 </simpara>\r
695 </listitem>\r
696 </varlistentry>\r
697 <varlistentry>\r
698 <term>\r
699 [--] &lt;path&gt;&#8230;\r
700 </term>\r
701 <listitem>\r
702 <simpara>\r
703         Show only commits that affect any of the specified paths. To\r
704         prevent confusion with options and branch names, paths may need\r
705         to be prefixed with "-- " to separate them from options or\r
706         refnames.\r
707 </simpara>\r
708 </listitem>\r
709 </varlistentry>\r
710 </variablelist>\r
711 <simplesect id="_commit_formatting">\r
712 <title>Commit Formatting</title>\r
713 <variablelist>\r
714 <varlistentry>\r
715 <term>\r
716 --pretty[=<emphasis>&lt;format&gt;</emphasis>]\r
717 </term>\r
718 <listitem>\r
719 <simpara>\r
720         Pretty-print the contents of the commit logs in a given format,\r
721         where <emphasis>&lt;format&gt;</emphasis> can be one of <emphasis>oneline</emphasis>, <emphasis>short</emphasis>, <emphasis>medium</emphasis>,\r
722         <emphasis>full</emphasis>, <emphasis>fuller</emphasis>, <emphasis>email</emphasis>, <emphasis>raw</emphasis> and <emphasis>format:&lt;string&gt;</emphasis>.\r
723         When omitted, the format defaults to <emphasis>medium</emphasis>.\r
724 </simpara>\r
725 <simpara>Note: you can specify the default pretty format in the repository\r
726 configuration (see <xref linkend="git-config(1)"/>).</simpara>\r
727 </listitem>\r
728 </varlistentry>\r
729 <varlistentry>\r
730 <term>\r
731 --abbrev-commit\r
732 </term>\r
733 <listitem>\r
734 <simpara>\r
735         Instead of showing the full 40-byte hexadecimal commit object\r
736         name, show only a partial prefix.  Non default number of\r
737         digits can be specified with "--abbrev=&lt;n&gt;" (which also modifies\r
738         diff output, if it is displayed).\r
739 </simpara>\r
740 <simpara>This should make "--pretty=oneline" a whole lot more readable for\r
741 people using 80-column terminals.</simpara>\r
742 </listitem>\r
743 </varlistentry>\r
744 <varlistentry>\r
745 <term>\r
746 --encoding[=&lt;encoding&gt;]\r
747 </term>\r
748 <listitem>\r
749 <simpara>\r
750         The commit objects record the encoding used for the log message\r
751         in their encoding header; this option can be used to tell the\r
752         command to re-code the commit log message in the encoding\r
753         preferred by the user.  For non plumbing commands this\r
754         defaults to UTF-8.\r
755 </simpara>\r
756 </listitem>\r
757 </varlistentry>\r
758 <varlistentry>\r
759 <term>\r
760 --relative-date\r
761 </term>\r
762 <listitem>\r
763 <simpara>\r
764         Synonym for <literal>--date=relative</literal>.\r
765 </simpara>\r
766 </listitem>\r
767 </varlistentry>\r
768 <varlistentry>\r
769 <term>\r
770 --date={relative,local,default,iso,rfc,short}\r
771 </term>\r
772 <listitem>\r
773 <simpara>\r
774         Only takes effect for dates shown in human-readable format, such\r
775         as when using "--pretty". <literal>log.date</literal> config variable sets a default\r
776         value for log command&#8217;s --date option.\r
777 </simpara>\r
778 <simpara><literal>--date=relative</literal> shows dates relative to the current time,\r
779 e.g. "2 hours ago".</simpara>\r
780 <simpara><literal>--date=local</literal> shows timestamps in user&#8217;s local timezone.</simpara>\r
781 <simpara><literal>--date=iso</literal> (or <literal>--date=iso8601</literal>) shows timestamps in ISO 8601 format.</simpara>\r
782 <simpara><literal>--date=rfc</literal> (or <literal>--date=rfc2822</literal>) shows timestamps in RFC 2822\r
783 format, often found in E-mail messages.</simpara>\r
784 <simpara><literal>--date=short</literal> shows only date but not time, in <literal>YYYY-MM-DD</literal> format.</simpara>\r
785 <simpara><literal>--date=default</literal> shows timestamps in the original timezone\r
786 (either committer&#8217;s or author&#8217;s).</simpara>\r
787 </listitem>\r
788 </varlistentry>\r
789 <varlistentry>\r
790 <term>\r
791 --parents\r
792 </term>\r
793 <listitem>\r
794 <simpara>\r
795         Print the parents of the commit.  Also enables parent\r
796         rewriting, see <emphasis>History Simplification</emphasis> below.\r
797 </simpara>\r
798 </listitem>\r
799 </varlistentry>\r
800 <varlistentry>\r
801 <term>\r
802 --children\r
803 </term>\r
804 <listitem>\r
805 <simpara>\r
806         Print the children of the commit.  Also enables parent\r
807         rewriting, see <emphasis>History Simplification</emphasis> below.\r
808 </simpara>\r
809 </listitem>\r
810 </varlistentry>\r
811 <varlistentry>\r
812 <term>\r
813 --left-right\r
814 </term>\r
815 <listitem>\r
816 <simpara>\r
817         Mark which side of a symmetric diff a commit is reachable from.\r
818         Commits from the left side are prefixed with <literal>&lt;</literal> and those from\r
819         the right with <literal>&gt;</literal>.  If combined with <literal>--boundary</literal>, those\r
820         commits are prefixed with <literal>-</literal>.\r
821 </simpara>\r
822 <simpara>For example, if you have this topology:</simpara>\r
823 <literallayout>             y---b---b  branch B\r
824             / \ /\r
825            /   .\r
826           /   / \\r
827          o---x---a---a  branch A</literallayout>\r
828 <simpara>you would get an output like this:</simpara>\r
829 <literallayout>        $ git rev-list --left-right --boundary --pretty=oneline A...B\r
830 \r
831         &gt;bbbbbbb... 3rd on b\r
832         &gt;bbbbbbb... 2nd on b\r
833         &lt;aaaaaaa... 3rd on a\r
834         &lt;aaaaaaa... 2nd on a\r
835         -yyyyyyy... 1st on b\r
836         -xxxxxxx... 1st on a</literallayout>\r
837 </listitem>\r
838 </varlistentry>\r
839 <varlistentry>\r
840 <term>\r
841 --graph\r
842 </term>\r
843 <listitem>\r
844 <simpara>\r
845         Draw a text-based graphical representation of the commit history\r
846         on the left hand side of the output.  This may cause extra lines\r
847         to be printed in between commits, in order for the graph history\r
848         to be drawn properly.\r
849 </simpara>\r
850 <simpara>This implies the <emphasis>--topo-order</emphasis> option by default, but the\r
851 <emphasis>--date-order</emphasis> option may also be specified.</simpara>\r
852 </listitem>\r
853 </varlistentry>\r
854 </variablelist>\r
855 </simplesect>\r
856 <simplesect id="_diff_formatting">\r
857 <title>Diff Formatting</title>\r
858 <simpara>Below are listed options that control the formatting of diff output.\r
859 Some of them are specific to <xref linkend="git-rev-list(1)"/>, however other diff\r
860 options may be given. See <xref linkend="git-diff-files(1)"/> for more options.</simpara>\r
861 <variablelist>\r
862 <varlistentry>\r
863 <term>\r
864 -c\r
865 </term>\r
866 <listitem>\r
867 <simpara>\r
868         This flag changes the way a merge commit is displayed.  It shows\r
869         the differences from each of the parents to the merge result\r
870         simultaneously instead of showing pairwise diff between a parent\r
871         and the result one at a time. Furthermore, it lists only files\r
872         which were modified from all parents.\r
873 </simpara>\r
874 </listitem>\r
875 </varlistentry>\r
876 <varlistentry>\r
877 <term>\r
878 --cc\r
879 </term>\r
880 <listitem>\r
881 <simpara>\r
882         This flag implies the <emphasis>-c</emphasis> options and further compresses the\r
883         patch output by omitting uninteresting hunks whose contents in\r
884         the parents have only two variants and the merge result picks\r
885         one of them without modification.\r
886 </simpara>\r
887 </listitem>\r
888 </varlistentry>\r
889 <varlistentry>\r
890 <term>\r
891 -r\r
892 </term>\r
893 <listitem>\r
894 <simpara>\r
895         Show recursive diffs.\r
896 </simpara>\r
897 </listitem>\r
898 </varlistentry>\r
899 <varlistentry>\r
900 <term>\r
901 -t\r
902 </term>\r
903 <listitem>\r
904 <simpara>\r
905         Show the tree objects in the diff output. This implies <emphasis>-r</emphasis>.\r
906 </simpara>\r
907 </listitem>\r
908 </varlistentry>\r
909 </variablelist>\r
910 </simplesect>\r
911 <simplesect id="_commit_limiting">\r
912 <title>Commit Limiting</title>\r
913 <simpara>Besides specifying a range of commits that should be listed using the\r
914 special notations explained in the description, additional commit\r
915 limiting may be applied.</simpara>\r
916 <variablelist>\r
917 <varlistentry>\r
918 <term>\r
919 -n <emphasis>number</emphasis>\r
920 </term>\r
921 <term>\r
922 --max-count=<emphasis>number</emphasis>\r
923 </term>\r
924 <listitem>\r
925 <simpara>\r
926         Limit the number of commits output.\r
927 </simpara>\r
928 </listitem>\r
929 </varlistentry>\r
930 <varlistentry>\r
931 <term>\r
932 --skip=<emphasis>number</emphasis>\r
933 </term>\r
934 <listitem>\r
935 <simpara>\r
936         Skip <emphasis>number</emphasis> commits before starting to show the commit output.\r
937 </simpara>\r
938 </listitem>\r
939 </varlistentry>\r
940 <varlistentry>\r
941 <term>\r
942 --since=<emphasis>date</emphasis>\r
943 </term>\r
944 <term>\r
945 --after=<emphasis>date</emphasis>\r
946 </term>\r
947 <listitem>\r
948 <simpara>\r
949         Show commits more recent than a specific date.\r
950 </simpara>\r
951 </listitem>\r
952 </varlistentry>\r
953 <varlistentry>\r
954 <term>\r
955 --until=<emphasis>date</emphasis>\r
956 </term>\r
957 <term>\r
958 --before=<emphasis>date</emphasis>\r
959 </term>\r
960 <listitem>\r
961 <simpara>\r
962         Show commits older than a specific date.\r
963 </simpara>\r
964 </listitem>\r
965 </varlistentry>\r
966 <varlistentry>\r
967 <term>\r
968 --author=<emphasis>pattern</emphasis>\r
969 </term>\r
970 <term>\r
971 --committer=<emphasis>pattern</emphasis>\r
972 </term>\r
973 <listitem>\r
974 <simpara>\r
975         Limit the commits output to ones with author/committer\r
976         header lines that match the specified pattern (regular expression).\r
977 </simpara>\r
978 </listitem>\r
979 </varlistentry>\r
980 <varlistentry>\r
981 <term>\r
982 --grep=<emphasis>pattern</emphasis>\r
983 </term>\r
984 <listitem>\r
985 <simpara>\r
986         Limit the commits output to ones with log message that\r
987         matches the specified pattern (regular expression).\r
988 </simpara>\r
989 </listitem>\r
990 </varlistentry>\r
991 <varlistentry>\r
992 <term>\r
993 --all-match\r
994 </term>\r
995 <listitem>\r
996 <simpara>\r
997         Limit the commits output to ones that match all given --grep,\r
998         --author and --committer instead of ones that match at least one.\r
999 </simpara>\r
1000 </listitem>\r
1001 </varlistentry>\r
1002 <varlistentry>\r
1003 <term>\r
1004 -i\r
1005 </term>\r
1006 <term>\r
1007 --regexp-ignore-case\r
1008 </term>\r
1009 <listitem>\r
1010 <simpara>\r
1011         Match the regexp limiting patterns without regard to letters case.\r
1012 </simpara>\r
1013 </listitem>\r
1014 </varlistentry>\r
1015 <varlistentry>\r
1016 <term>\r
1017 -E\r
1018 </term>\r
1019 <term>\r
1020 --extended-regexp\r
1021 </term>\r
1022 <listitem>\r
1023 <simpara>\r
1024         Consider the limiting patterns to be extended regular expressions\r
1025         instead of the default basic regular expressions.\r
1026 </simpara>\r
1027 </listitem>\r
1028 </varlistentry>\r
1029 <varlistentry>\r
1030 <term>\r
1031 -F\r
1032 </term>\r
1033 <term>\r
1034 --fixed-strings\r
1035 </term>\r
1036 <listitem>\r
1037 <simpara>\r
1038         Consider the limiting patterns to be fixed strings (don&#8217;t interpret\r
1039         pattern as a regular expression).\r
1040 </simpara>\r
1041 </listitem>\r
1042 </varlistentry>\r
1043 <varlistentry>\r
1044 <term>\r
1045 --remove-empty\r
1046 </term>\r
1047 <listitem>\r
1048 <simpara>\r
1049         Stop when a given path disappears from the tree.\r
1050 </simpara>\r
1051 </listitem>\r
1052 </varlistentry>\r
1053 <varlistentry>\r
1054 <term>\r
1055 --no-merges\r
1056 </term>\r
1057 <listitem>\r
1058 <simpara>\r
1059         Do not print commits with more than one parent.\r
1060 </simpara>\r
1061 </listitem>\r
1062 </varlistentry>\r
1063 <varlistentry>\r
1064 <term>\r
1065 --first-parent\r
1066 </term>\r
1067 <listitem>\r
1068 <simpara>\r
1069         Follow only the first parent commit upon seeing a merge\r
1070         commit.  This option can give a better overview when\r
1071         viewing the evolution of a particular topic branch,\r
1072         because merges into a topic branch tend to be only about\r
1073         adjusting to updated upstream from time to time, and\r
1074         this option allows you to ignore the individual commits\r
1075         brought in to your history by such a merge.\r
1076 </simpara>\r
1077 </listitem>\r
1078 </varlistentry>\r
1079 <varlistentry>\r
1080 <term>\r
1081 --not\r
1082 </term>\r
1083 <listitem>\r
1084 <simpara>\r
1085         Reverses the meaning of the <emphasis>&#94;</emphasis> prefix (or lack thereof)\r
1086         for all following revision specifiers, up to the next <emphasis>--not</emphasis>.\r
1087 </simpara>\r
1088 </listitem>\r
1089 </varlistentry>\r
1090 <varlistentry>\r
1091 <term>\r
1092 --all\r
1093 </term>\r
1094 <listitem>\r
1095 <simpara>\r
1096         Pretend as if all the refs in <literal>$GIT_DIR/refs/</literal> are listed on the\r
1097         command line as <emphasis>&lt;commit&gt;</emphasis>.\r
1098 </simpara>\r
1099 </listitem>\r
1100 </varlistentry>\r
1101 <varlistentry>\r
1102 <term>\r
1103 --branches\r
1104 </term>\r
1105 <listitem>\r
1106 <simpara>\r
1107         Pretend as if all the refs in <literal>$GIT_DIR/refs/heads</literal> are listed\r
1108         on the command line as <emphasis>&lt;commit&gt;</emphasis>.\r
1109 </simpara>\r
1110 </listitem>\r
1111 </varlistentry>\r
1112 <varlistentry>\r
1113 <term>\r
1114 --tags\r
1115 </term>\r
1116 <listitem>\r
1117 <simpara>\r
1118         Pretend as if all the refs in <literal>$GIT_DIR/refs/tags</literal> are listed\r
1119         on the command line as <emphasis>&lt;commit&gt;</emphasis>.\r
1120 </simpara>\r
1121 </listitem>\r
1122 </varlistentry>\r
1123 <varlistentry>\r
1124 <term>\r
1125 --remotes\r
1126 </term>\r
1127 <listitem>\r
1128 <simpara>\r
1129         Pretend as if all the refs in <literal>$GIT_DIR/refs/remotes</literal> are listed\r
1130         on the command line as <emphasis>&lt;commit&gt;</emphasis>.\r
1131 </simpara>\r
1132 </listitem>\r
1133 </varlistentry>\r
1134 <varlistentry>\r
1135 <term>\r
1136 --cherry-pick\r
1137 </term>\r
1138 <listitem>\r
1139 <simpara>\r
1140         Omit any commit that introduces the same change as\r
1141         another commit on the "other side" when the set of\r
1142         commits are limited with symmetric difference.\r
1143 </simpara>\r
1144 <simpara>For example, if you have two branches, <literal>A</literal> and <literal>B</literal>, a usual way\r
1145 to list all commits on only one side of them is with\r
1146 <literal>--left-right</literal>, like the example above in the description of\r
1147 that option.  It however shows the commits that were cherry-picked\r
1148 from the other branch (for example, "3rd on b" may be cherry-picked\r
1149 from branch A).  With this option, such pairs of commits are\r
1150 excluded from the output.</simpara>\r
1151 </listitem>\r
1152 </varlistentry>\r
1153 <varlistentry>\r
1154 <term>\r
1155 -g\r
1156 </term>\r
1157 <term>\r
1158 --walk-reflogs\r
1159 </term>\r
1160 <listitem>\r
1161 <simpara>\r
1162         Instead of walking the commit ancestry chain, walk\r
1163         reflog entries from the most recent one to older ones.\r
1164         When this option is used you cannot specify commits to\r
1165         exclude (that is, <emphasis>&#94;commit</emphasis>, <emphasis>commit1..commit2</emphasis>,\r
1166         nor <emphasis>commit1&#8230;commit2</emphasis> notations cannot be used).\r
1167 </simpara>\r
1168 <simpara>With <emphasis>--pretty</emphasis> format other than oneline (for obvious reasons),\r
1169 this causes the output to have two extra lines of information\r
1170 taken from the reflog.  By default, <emphasis>commit@{Nth}</emphasis> notation is\r
1171 used in the output.  When the starting commit is specified as\r
1172 <emphasis>commit@{now}</emphasis>, output also uses <emphasis>commit@{timestamp}</emphasis> notation\r
1173 instead.  Under <emphasis>--pretty=oneline</emphasis>, the commit message is\r
1174 prefixed with this information on the same line.\r
1175 This option cannot be combined with <emphasis>--reverse</emphasis>.\r
1176 See also <xref linkend="git-reflog(1)"/>.</simpara>\r
1177 </listitem>\r
1178 </varlistentry>\r
1179 <varlistentry>\r
1180 <term>\r
1181 --merge\r
1182 </term>\r
1183 <listitem>\r
1184 <simpara>\r
1185         After a failed merge, show refs that touch files having a\r
1186         conflict and don&#8217;t exist on all heads to merge.\r
1187 </simpara>\r
1188 </listitem>\r
1189 </varlistentry>\r
1190 <varlistentry>\r
1191 <term>\r
1192 --boundary\r
1193 </term>\r
1194 <listitem>\r
1195 <simpara>\r
1196         Output uninteresting commits at the boundary, which are usually\r
1197         not shown.\r
1198 </simpara>\r
1199 </listitem>\r
1200 </varlistentry>\r
1201 </variablelist>\r
1202 </simplesect>\r
1203 <simplesect id="_history_simplification">\r
1204 <title>History Simplification</title>\r
1205 <simpara>Sometimes you are only interested in parts of the history, for example the\r
1206 commits modifying a particular &lt;path&gt;. But there are two parts of\r
1207 <emphasis>History Simplification</emphasis>, one part is selecting the commits and the other\r
1208 is how to do it, as there are various strategies to simplify the history.</simpara>\r
1209 <simpara>The following options select the commits to be shown:</simpara>\r
1210 <variablelist>\r
1211 <varlistentry>\r
1212 <term>\r
1213 &lt;paths&gt;\r
1214 </term>\r
1215 <listitem>\r
1216 <simpara>\r
1217         Commits modifying the given &lt;paths&gt; are selected.\r
1218 </simpara>\r
1219 </listitem>\r
1220 </varlistentry>\r
1221 <varlistentry>\r
1222 <term>\r
1223 --simplify-by-decoration\r
1224 </term>\r
1225 <listitem>\r
1226 <simpara>\r
1227         Commits that are referred by some branch or tag are selected.\r
1228 </simpara>\r
1229 </listitem>\r
1230 </varlistentry>\r
1231 </variablelist>\r
1232 <simpara>Note that extra commits can be shown to give a meaningful history.</simpara>\r
1233 <simpara>The following options affect the way the simplification is performed:</simpara>\r
1234 <variablelist>\r
1235 <varlistentry>\r
1236 <term>\r
1237 Default mode\r
1238 </term>\r
1239 <listitem>\r
1240 <simpara>\r
1241         Simplifies the history to the simplest history explaining the\r
1242         final state of the tree. Simplest because it prunes some side\r
1243         branches if the end result is the same (i.e. merging branches\r
1244         with the same content)\r
1245 </simpara>\r
1246 </listitem>\r
1247 </varlistentry>\r
1248 <varlistentry>\r
1249 <term>\r
1250 --full-history\r
1251 </term>\r
1252 <listitem>\r
1253 <simpara>\r
1254         As the default mode but does not prune some history.\r
1255 </simpara>\r
1256 </listitem>\r
1257 </varlistentry>\r
1258 <varlistentry>\r
1259 <term>\r
1260 --dense\r
1261 </term>\r
1262 <listitem>\r
1263 <simpara>\r
1264         Only the selected commits are shown, plus some to have a\r
1265         meaningful history.\r
1266 </simpara>\r
1267 </listitem>\r
1268 </varlistentry>\r
1269 <varlistentry>\r
1270 <term>\r
1271 --sparse\r
1272 </term>\r
1273 <listitem>\r
1274 <simpara>\r
1275         All commits in the simplified history are shown.\r
1276 </simpara>\r
1277 </listitem>\r
1278 </varlistentry>\r
1279 <varlistentry>\r
1280 <term>\r
1281 --simplify-merges\r
1282 </term>\r
1283 <listitem>\r
1284 <simpara>\r
1285         Additional option to <emphasis>--full-history</emphasis> to remove some needless\r
1286         merges from the resulting history, as there are no selected\r
1287         commits contributing to this merge.\r
1288 </simpara>\r
1289 </listitem>\r
1290 </varlistentry>\r
1291 </variablelist>\r
1292 <simpara>A more detailed explanation follows.</simpara>\r
1293 <simpara>Suppose you specified <literal>foo</literal> as the &lt;paths&gt;.  We shall call commits\r
1294 that modify <literal>foo</literal> !TREESAME, and the rest TREESAME.  (In a diff\r
1295 filtered for <literal>foo</literal>, they look different and equal, respectively.)</simpara>\r
1296 <simpara>In the following, we will always refer to the same example history to\r
1297 illustrate the differences between simplification settings.  We assume\r
1298 that you are filtering for a file <literal>foo</literal> in this commit graph:</simpara>\r
1299 <literallayout>          .-A---M---N---O---P\r
1300          /     /   /   /   /\r
1301         I     B   C   D   E\r
1302          \   /   /   /   /\r
1303           `-------------'</literallayout>\r
1304 <simpara>The horizontal line of history A&#8212;P is taken to be the first parent of\r
1305 each merge.  The commits are:</simpara>\r
1306 <itemizedlist>\r
1307 <listitem>\r
1308 <simpara>\r
1309 <literal>I</literal> is the initial commit, in which <literal>foo</literal> exists with contents\r
1310   "asdf", and a file <literal>quux</literal> exists with contents "quux".  Initial\r
1311   commits are compared to an empty tree, so <literal>I</literal> is !TREESAME.\r
1312 </simpara>\r
1313 </listitem>\r
1314 <listitem>\r
1315 <simpara>\r
1316 In <literal>A</literal>, <literal>foo</literal> contains just "foo".\r
1317 </simpara>\r
1318 </listitem>\r
1319 <listitem>\r
1320 <simpara>\r
1321 <literal>B</literal> contains the same change as <literal>A</literal>.  Its merge <literal>M</literal> is trivial and\r
1322   hence TREESAME to all parents.\r
1323 </simpara>\r
1324 </listitem>\r
1325 <listitem>\r
1326 <simpara>\r
1327 <literal>C</literal> does not change <literal>foo</literal>, but its merge <literal>N</literal> changes it to "foobar",\r
1328   so it is not TREESAME to any parent.\r
1329 </simpara>\r
1330 </listitem>\r
1331 <listitem>\r
1332 <simpara>\r
1333 <literal>D</literal> sets <literal>foo</literal> to "baz".  Its merge <literal>O</literal> combines the strings from\r
1334   <literal>N</literal> and <literal>D</literal> to "foobarbaz"; i.e., it is not TREESAME to any parent.\r
1335 </simpara>\r
1336 </listitem>\r
1337 <listitem>\r
1338 <simpara>\r
1339 <literal>E</literal> changes <literal>quux</literal> to "xyzzy", and its merge <literal>P</literal> combines the\r
1340   strings to "quux xyzzy".  Despite appearing interesting, <literal>P</literal> is\r
1341   TREESAME to all parents.\r
1342 </simpara>\r
1343 </listitem>\r
1344 </itemizedlist>\r
1345 <simpara><emphasis>rev-list</emphasis> walks backwards through history, including or excluding\r
1346 commits based on whether <emphasis>--full-history</emphasis> and/or parent rewriting\r
1347 (via <emphasis>--parents</emphasis> or <emphasis>--children</emphasis>) are used.  The following settings\r
1348 are available.</simpara>\r
1349 <variablelist>\r
1350 <varlistentry>\r
1351 <term>\r
1352 Default mode\r
1353 </term>\r
1354 <listitem>\r
1355 <simpara>\r
1356         Commits are included if they are not TREESAME to any parent\r
1357         (though this can be changed, see <emphasis>--sparse</emphasis> below).  If the\r
1358         commit was a merge, and it was TREESAME to one parent, follow\r
1359         only that parent.  (Even if there are several TREESAME\r
1360         parents, follow only one of them.)  Otherwise, follow all\r
1361         parents.\r
1362 </simpara>\r
1363 <simpara>This results in:</simpara>\r
1364 <literallayout>          .-A---N---O\r
1365          /         /\r
1366         I---------D</literallayout>\r
1367 <simpara>Note how the rule to only follow the TREESAME parent, if one is\r
1368 available, removed <literal>B</literal> from consideration entirely.  <literal>C</literal> was\r
1369 considered via <literal>N</literal>, but is TREESAME.  Root commits are compared to an\r
1370 empty tree, so <literal>I</literal> is !TREESAME.</simpara>\r
1371 <simpara>Parent/child relations are only visible with --parents, but that does\r
1372 not affect the commits selected in default mode, so we have shown the\r
1373 parent lines.</simpara>\r
1374 </listitem>\r
1375 </varlistentry>\r
1376 <varlistentry>\r
1377 <term>\r
1378 --full-history without parent rewriting\r
1379 </term>\r
1380 <listitem>\r
1381 <simpara>\r
1382         This mode differs from the default in one point: always follow\r
1383         all parents of a merge, even if it is TREESAME to one of them.\r
1384         Even if more than one side of the merge has commits that are\r
1385         included, this does not imply that the merge itself is!  In\r
1386         the example, we get\r
1387 </simpara>\r
1388 <literallayout>        I  A  B  N  D  O</literallayout>\r
1389 <simpara><literal>P</literal> and <literal>M</literal> were excluded because they are TREESAME to a parent.  <literal>E</literal>,\r
1390 <literal>C</literal> and <literal>B</literal> were all walked, but only <literal>B</literal> was !TREESAME, so the others\r
1391 do not appear.</simpara>\r
1392 <simpara>Note that without parent rewriting, it is not really possible to talk\r
1393 about the parent/child relationships between the commits, so we show\r
1394 them disconnected.</simpara>\r
1395 </listitem>\r
1396 </varlistentry>\r
1397 <varlistentry>\r
1398 <term>\r
1399 --full-history with parent rewriting\r
1400 </term>\r
1401 <listitem>\r
1402 <simpara>\r
1403         Ordinary commits are only included if they are !TREESAME\r
1404         (though this can be changed, see <emphasis>--sparse</emphasis> below).\r
1405 </simpara>\r
1406 <simpara>Merges are always included.  However, their parent list is rewritten:\r
1407 Along each parent, prune away commits that are not included\r
1408 themselves.  This results in</simpara>\r
1409 <literallayout>          .-A---M---N---O---P\r
1410          /     /   /   /   /\r
1411         I     B   /   D   /\r
1412          \   /   /   /   /\r
1413           `-------------'</literallayout>\r
1414 <simpara>Compare to <emphasis>--full-history</emphasis> without rewriting above.  Note that <literal>E</literal>\r
1415 was pruned away because it is TREESAME, but the parent list of P was\r
1416 rewritten to contain <literal>E</literal>'s parent <literal>I</literal>.  The same happened for <literal>C</literal> and\r
1417 <literal>N</literal>.  Note also that <literal>P</literal> was included despite being TREESAME.</simpara>\r
1418 </listitem>\r
1419 </varlistentry>\r
1420 </variablelist>\r
1421 <simpara>In addition to the above settings, you can change whether TREESAME\r
1422 affects inclusion:</simpara>\r
1423 <variablelist>\r
1424 <varlistentry>\r
1425 <term>\r
1426 --dense\r
1427 </term>\r
1428 <listitem>\r
1429 <simpara>\r
1430         Commits that are walked are included if they are not TREESAME\r
1431         to any parent.\r
1432 </simpara>\r
1433 </listitem>\r
1434 </varlistentry>\r
1435 <varlistentry>\r
1436 <term>\r
1437 --sparse\r
1438 </term>\r
1439 <listitem>\r
1440 <simpara>\r
1441         All commits that are walked are included.\r
1442 </simpara>\r
1443 <simpara>Note that without <emphasis>--full-history</emphasis>, this still simplifies merges: if\r
1444 one of the parents is TREESAME, we follow only that one, so the other\r
1445 sides of the merge are never walked.</simpara>\r
1446 </listitem>\r
1447 </varlistentry>\r
1448 </variablelist>\r
1449 <simpara>Finally, there is a fourth simplification mode available:</simpara>\r
1450 <variablelist>\r
1451 <varlistentry>\r
1452 <term>\r
1453 --simplify-merges\r
1454 </term>\r
1455 <listitem>\r
1456 <simpara>\r
1457         First, build a history graph in the same way that\r
1458         <emphasis>--full-history</emphasis> with parent rewriting does (see above).\r
1459 </simpara>\r
1460 <simpara>Then simplify each commit &#8216;C` to its replacement <literal>C&#8217;</literal> in the final\r
1461 history according to the following rules:</simpara>\r
1462 <itemizedlist>\r
1463 <listitem>\r
1464 <simpara>\r
1465 Set &#8216;C&#8217;<literal> to `C</literal>.\r
1466 </simpara>\r
1467 </listitem>\r
1468 <listitem>\r
1469 <simpara>\r
1470 Replace each parent &#8216;P` of <literal>C&#8217;</literal> with its simplification &#8216;P&#8217;`.  In\r
1471   the process, drop parents that are ancestors of other parents, and\r
1472   remove duplicates.\r
1473 </simpara>\r
1474 </listitem>\r
1475 <listitem>\r
1476 <simpara>\r
1477 If after this parent rewriting, &#8216;C&#8217;` is a root or merge commit (has\r
1478   zero or &gt;1 parents), a boundary commit, or !TREESAME, it remains.\r
1479   Otherwise, it is replaced with its only parent.\r
1480 </simpara>\r
1481 </listitem>\r
1482 </itemizedlist>\r
1483 <simpara>The effect of this is best shown by way of comparing to\r
1484 <emphasis>--full-history</emphasis> with parent rewriting.  The example turns into:</simpara>\r
1485 <literallayout>          .-A---M---N---O\r
1486          /     /       /\r
1487         I     B       D\r
1488          \   /       /\r
1489           `---------'</literallayout>\r
1490 <simpara>Note the major differences in <literal>N</literal> and <literal>P</literal> over <emphasis>--full-history</emphasis>:</simpara>\r
1491 <itemizedlist>\r
1492 <listitem>\r
1493 <simpara>\r
1494 <literal>N</literal>'s parent list had <literal>I</literal> removed, because it is an ancestor of the\r
1495   other parent <literal>M</literal>.  Still, <literal>N</literal> remained because it is !TREESAME.\r
1496 </simpara>\r
1497 </listitem>\r
1498 <listitem>\r
1499 <simpara>\r
1500 <literal>P</literal>'s parent list similarly had <literal>I</literal> removed.  <literal>P</literal> was then\r
1501   removed completely, because it had one parent and is TREESAME.\r
1502 </simpara>\r
1503 </listitem>\r
1504 </itemizedlist>\r
1505 </listitem>\r
1506 </varlistentry>\r
1507 </variablelist>\r
1508 <simpara>The <emphasis>--simplify-by-decoration</emphasis> option allows you to view only the\r
1509 big picture of the topology of the history, by omitting commits\r
1510 that are not referenced by tags.  Commits are marked as !TREESAME\r
1511 (in other words, kept after history simplification rules described\r
1512 above) if (1) they are referenced by tags, or (2) they change the\r
1513 contents of the paths given on the command line.  All other\r
1514 commits are marked as TREESAME (subject to be simplified away).</simpara>\r
1515 </simplesect>\r
1516 <simplesect id="_commit_ordering">\r
1517 <title>Commit Ordering</title>\r
1518 <simpara>By default, the commits are shown in reverse chronological order.</simpara>\r
1519 <variablelist>\r
1520 <varlistentry>\r
1521 <term>\r
1522 --topo-order\r
1523 </term>\r
1524 <listitem>\r
1525 <simpara>\r
1526         This option makes them appear in topological order (i.e.\r
1527         descendant commits are shown before their parents).\r
1528 </simpara>\r
1529 </listitem>\r
1530 </varlistentry>\r
1531 <varlistentry>\r
1532 <term>\r
1533 --date-order\r
1534 </term>\r
1535 <listitem>\r
1536 <simpara>\r
1537         This option is similar to <emphasis>--topo-order</emphasis> in the sense that no\r
1538         parent comes before all of its children, but otherwise things\r
1539         are still ordered in the commit timestamp order.\r
1540 </simpara>\r
1541 </listitem>\r
1542 </varlistentry>\r
1543 <varlistentry>\r
1544 <term>\r
1545 --reverse\r
1546 </term>\r
1547 <listitem>\r
1548 <simpara>\r
1549         Output the commits in reverse order.\r
1550         Cannot be combined with <emphasis>--walk-reflogs</emphasis>.\r
1551 </simpara>\r
1552 </listitem>\r
1553 </varlistentry>\r
1554 </variablelist>\r
1555 </simplesect>\r
1556 <simplesect id="_object_traversal">\r
1557 <title>Object Traversal</title>\r
1558 <simpara>These options are mostly targeted for packing of git repositories.</simpara>\r
1559 <variablelist>\r
1560 <varlistentry>\r
1561 <term>\r
1562 --objects\r
1563 </term>\r
1564 <listitem>\r
1565 <simpara>\r
1566         Print the object IDs of any object referenced by the listed\r
1567         commits.  <emphasis>--objects foo ^bar</emphasis> thus means "send me\r
1568         all object IDs which I need to download if I have the commit\r
1569         object <emphasis>bar</emphasis>, but not <emphasis>foo</emphasis>".\r
1570 </simpara>\r
1571 </listitem>\r
1572 </varlistentry>\r
1573 <varlistentry>\r
1574 <term>\r
1575 --objects-edge\r
1576 </term>\r
1577 <listitem>\r
1578 <simpara>\r
1579         Similar to <emphasis>--objects</emphasis>, but also print the IDs of excluded\r
1580         commits prefixed with a "-" character.  This is used by\r
1581         <xref linkend="git-pack-objects(1)"/> to build "thin" pack, which records\r
1582         objects in deltified form based on objects contained in these\r
1583         excluded commits to reduce network traffic.\r
1584 </simpara>\r
1585 </listitem>\r
1586 </varlistentry>\r
1587 <varlistentry>\r
1588 <term>\r
1589 --unpacked\r
1590 </term>\r
1591 <listitem>\r
1592 <simpara>\r
1593         Only useful with <emphasis>--objects</emphasis>; print the object IDs that are not\r
1594         in packs.\r
1595 </simpara>\r
1596 </listitem>\r
1597 </varlistentry>\r
1598 <varlistentry>\r
1599 <term>\r
1600 --no-walk\r
1601 </term>\r
1602 <listitem>\r
1603 <simpara>\r
1604         Only show the given revs, but do not traverse their ancestors.\r
1605 </simpara>\r
1606 </listitem>\r
1607 </varlistentry>\r
1608 <varlistentry>\r
1609 <term>\r
1610 --do-walk\r
1611 </term>\r
1612 <listitem>\r
1613 <simpara>\r
1614         Overrides a previous --no-walk.\r
1615 </simpara>\r
1616 </listitem>\r
1617 </varlistentry>\r
1618 </variablelist>\r
1619 </simplesect>\r
1620 </simplesect>\r
1621 <simplesect id="_pretty_formats">\r
1622 <title>PRETTY FORMATS</title>\r
1623 <simpara>If the commit is a merge, and if the pretty-format\r
1624 is not <emphasis>oneline</emphasis>, <emphasis>email</emphasis> or <emphasis>raw</emphasis>, an additional line is\r
1625 inserted before the <emphasis>Author:</emphasis> line.  This line begins with\r
1626 "Merge: " and the sha1s of ancestral commits are printed,\r
1627 separated by spaces.  Note that the listed commits may not\r
1628 necessarily be the list of the <emphasis role="strong">direct</emphasis> parent commits if you\r
1629 have limited your view of history: for example, if you are\r
1630 only interested in changes related to a certain directory or\r
1631 file.</simpara>\r
1632 <simpara>Here are some additional details for each format:</simpara>\r
1633 <itemizedlist>\r
1634 <listitem>\r
1635 <simpara>\r
1636 <emphasis>oneline</emphasis>\r
1637 </simpara>\r
1638 <literallayout class="monospaced">&lt;sha1&gt; &lt;title line&gt;</literallayout>\r
1639 <simpara>This is designed to be as compact as possible.</simpara>\r
1640 </listitem>\r
1641 <listitem>\r
1642 <simpara>\r
1643 <emphasis>short</emphasis>\r
1644 </simpara>\r
1645 <literallayout class="monospaced">commit &lt;sha1&gt;\r
1646 Author: &lt;author&gt;</literallayout>\r
1647 <literallayout class="monospaced">&lt;title line&gt;</literallayout>\r
1648 </listitem>\r
1649 <listitem>\r
1650 <simpara>\r
1651 <emphasis>medium</emphasis>\r
1652 </simpara>\r
1653 <literallayout class="monospaced">commit &lt;sha1&gt;\r
1654 Author: &lt;author&gt;\r
1655 Date:   &lt;author date&gt;</literallayout>\r
1656 <literallayout class="monospaced">&lt;title line&gt;</literallayout>\r
1657 <literallayout class="monospaced">&lt;full commit message&gt;</literallayout>\r
1658 </listitem>\r
1659 <listitem>\r
1660 <simpara>\r
1661 <emphasis>full</emphasis>\r
1662 </simpara>\r
1663 <literallayout class="monospaced">commit &lt;sha1&gt;\r
1664 Author: &lt;author&gt;\r
1665 Commit: &lt;committer&gt;</literallayout>\r
1666 <literallayout class="monospaced">&lt;title line&gt;</literallayout>\r
1667 <literallayout class="monospaced">&lt;full commit message&gt;</literallayout>\r
1668 </listitem>\r
1669 <listitem>\r
1670 <simpara>\r
1671 <emphasis>fuller</emphasis>\r
1672 </simpara>\r
1673 <literallayout class="monospaced">commit &lt;sha1&gt;\r
1674 Author:     &lt;author&gt;\r
1675 AuthorDate: &lt;author date&gt;\r
1676 Commit:     &lt;committer&gt;\r
1677 CommitDate: &lt;committer date&gt;</literallayout>\r
1678 <literallayout class="monospaced">&lt;title line&gt;</literallayout>\r
1679 <literallayout class="monospaced">&lt;full commit message&gt;</literallayout>\r
1680 </listitem>\r
1681 <listitem>\r
1682 <simpara>\r
1683 <emphasis>email</emphasis>\r
1684 </simpara>\r
1685 <literallayout class="monospaced">From &lt;sha1&gt; &lt;date&gt;\r
1686 From: &lt;author&gt;\r
1687 Date: &lt;author date&gt;\r
1688 Subject: [PATCH] &lt;title line&gt;</literallayout>\r
1689 <literallayout class="monospaced">&lt;full commit message&gt;</literallayout>\r
1690 </listitem>\r
1691 <listitem>\r
1692 <simpara>\r
1693 <emphasis>raw</emphasis>\r
1694 </simpara>\r
1695 <simpara>The <emphasis>raw</emphasis> format shows the entire commit exactly as\r
1696 stored in the commit object.  Notably, the SHA1s are\r
1697 displayed in full, regardless of whether --abbrev or\r
1698 --no-abbrev are used, and <emphasis>parents</emphasis> information show the\r
1699 true parent commits, without taking grafts nor history\r
1700 simplification into account.</simpara>\r
1701 </listitem>\r
1702 <listitem>\r
1703 <simpara>\r
1704 <emphasis>format:</emphasis>\r
1705 </simpara>\r
1706 <simpara>The <emphasis>format:</emphasis> format allows you to specify which information\r
1707 you want to show. It works a little bit like printf format,\r
1708 with the notable exception that you get a newline with <emphasis>%n</emphasis>\r
1709 instead of <emphasis>\n</emphasis>.</simpara>\r
1710 <simpara>E.g, <emphasis>format:"The author of %h was %an, %ar%nThe title was &gt;&gt;%s&lt;&lt;%n"</emphasis>\r
1711 would show something like this:</simpara>\r
1712 <literallayout>The author of fe6e0ee was Junio C Hamano, 23 hours ago\r
1713 The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;</literallayout>\r
1714 <simpara>The placeholders are:</simpara>\r
1715 <itemizedlist>\r
1716 <listitem>\r
1717 <simpara>\r
1718 <emphasis>%H</emphasis>: commit hash\r
1719 </simpara>\r
1720 </listitem>\r
1721 <listitem>\r
1722 <simpara>\r
1723 <emphasis>%h</emphasis>: abbreviated commit hash\r
1724 </simpara>\r
1725 </listitem>\r
1726 <listitem>\r
1727 <simpara>\r
1728 <emphasis>%T</emphasis>: tree hash\r
1729 </simpara>\r
1730 </listitem>\r
1731 <listitem>\r
1732 <simpara>\r
1733 <emphasis>%t</emphasis>: abbreviated tree hash\r
1734 </simpara>\r
1735 </listitem>\r
1736 <listitem>\r
1737 <simpara>\r
1738 <emphasis>%P</emphasis>: parent hashes\r
1739 </simpara>\r
1740 </listitem>\r
1741 <listitem>\r
1742 <simpara>\r
1743 <emphasis>%p</emphasis>: abbreviated parent hashes\r
1744 </simpara>\r
1745 </listitem>\r
1746 <listitem>\r
1747 <simpara>\r
1748 <emphasis>%an</emphasis>: author name\r
1749 </simpara>\r
1750 </listitem>\r
1751 <listitem>\r
1752 <simpara>\r
1753 <emphasis>%aN</emphasis>: author name (respecting .mailmap)\r
1754 </simpara>\r
1755 </listitem>\r
1756 <listitem>\r
1757 <simpara>\r
1758 <emphasis>%ae</emphasis>: author email\r
1759 </simpara>\r
1760 </listitem>\r
1761 <listitem>\r
1762 <simpara>\r
1763 <emphasis>%aE</emphasis>: author email (respecting .mailmap)\r
1764 </simpara>\r
1765 </listitem>\r
1766 <listitem>\r
1767 <simpara>\r
1768 <emphasis>%ad</emphasis>: author date (format respects --date= option)\r
1769 </simpara>\r
1770 </listitem>\r
1771 <listitem>\r
1772 <simpara>\r
1773 <emphasis>%aD</emphasis>: author date, RFC2822 style\r
1774 </simpara>\r
1775 </listitem>\r
1776 <listitem>\r
1777 <simpara>\r
1778 <emphasis>%ar</emphasis>: author date, relative\r
1779 </simpara>\r
1780 </listitem>\r
1781 <listitem>\r
1782 <simpara>\r
1783 <emphasis>%at</emphasis>: author date, UNIX timestamp\r
1784 </simpara>\r
1785 </listitem>\r
1786 <listitem>\r
1787 <simpara>\r
1788 <emphasis>%ai</emphasis>: author date, ISO 8601 format\r
1789 </simpara>\r
1790 </listitem>\r
1791 <listitem>\r
1792 <simpara>\r
1793 <emphasis>%cn</emphasis>: committer name\r
1794 </simpara>\r
1795 </listitem>\r
1796 <listitem>\r
1797 <simpara>\r
1798 <emphasis>%cN</emphasis>: committer name (respecting .mailmap)\r
1799 </simpara>\r
1800 </listitem>\r
1801 <listitem>\r
1802 <simpara>\r
1803 <emphasis>%ce</emphasis>: committer email\r
1804 </simpara>\r
1805 </listitem>\r
1806 <listitem>\r
1807 <simpara>\r
1808 <emphasis>%cE</emphasis>: committer email (respecting .mailmap)\r
1809 </simpara>\r
1810 </listitem>\r
1811 <listitem>\r
1812 <simpara>\r
1813 <emphasis>%cd</emphasis>: committer date\r
1814 </simpara>\r
1815 </listitem>\r
1816 <listitem>\r
1817 <simpara>\r
1818 <emphasis>%cD</emphasis>: committer date, RFC2822 style\r
1819 </simpara>\r
1820 </listitem>\r
1821 <listitem>\r
1822 <simpara>\r
1823 <emphasis>%cr</emphasis>: committer date, relative\r
1824 </simpara>\r
1825 </listitem>\r
1826 <listitem>\r
1827 <simpara>\r
1828 <emphasis>%ct</emphasis>: committer date, UNIX timestamp\r
1829 </simpara>\r
1830 </listitem>\r
1831 <listitem>\r
1832 <simpara>\r
1833 <emphasis>%ci</emphasis>: committer date, ISO 8601 format\r
1834 </simpara>\r
1835 </listitem>\r
1836 <listitem>\r
1837 <simpara>\r
1838 <emphasis>%d</emphasis>: ref names, like the --decorate option of <xref linkend="git-log(1)"/>\r
1839 </simpara>\r
1840 </listitem>\r
1841 <listitem>\r
1842 <simpara>\r
1843 <emphasis>%e</emphasis>: encoding\r
1844 </simpara>\r
1845 </listitem>\r
1846 <listitem>\r
1847 <simpara>\r
1848 <emphasis>%s</emphasis>: subject\r
1849 </simpara>\r
1850 </listitem>\r
1851 <listitem>\r
1852 <simpara>\r
1853 <emphasis>%b</emphasis>: body\r
1854 </simpara>\r
1855 </listitem>\r
1856 <listitem>\r
1857 <simpara>\r
1858 <emphasis>%Cred</emphasis>: switch color to red\r
1859 </simpara>\r
1860 </listitem>\r
1861 <listitem>\r
1862 <simpara>\r
1863 <emphasis>%Cgreen</emphasis>: switch color to green\r
1864 </simpara>\r
1865 </listitem>\r
1866 <listitem>\r
1867 <simpara>\r
1868 <emphasis>%Cblue</emphasis>: switch color to blue\r
1869 </simpara>\r
1870 </listitem>\r
1871 <listitem>\r
1872 <simpara>\r
1873 <emphasis>%Creset</emphasis>: reset color\r
1874 </simpara>\r
1875 </listitem>\r
1876 <listitem>\r
1877 <simpara>\r
1878 <emphasis>%C(&#8230;)</emphasis>: color specification, as described in color.branch.* config option\r
1879 </simpara>\r
1880 </listitem>\r
1881 <listitem>\r
1882 <simpara>\r
1883 <emphasis>%m</emphasis>: left, right or boundary mark\r
1884 </simpara>\r
1885 </listitem>\r
1886 <listitem>\r
1887 <simpara>\r
1888 <emphasis>%n</emphasis>: newline\r
1889 </simpara>\r
1890 </listitem>\r
1891 <listitem>\r
1892 <simpara>\r
1893 <emphasis>%x00</emphasis>: print a byte from a hex code\r
1894 </simpara>\r
1895 </listitem>\r
1896 </itemizedlist>\r
1897 </listitem>\r
1898 <listitem>\r
1899 <simpara>\r
1900 <emphasis>tformat:</emphasis>\r
1901 </simpara>\r
1902 <simpara>The <emphasis>tformat:</emphasis> format works exactly like <emphasis>format:</emphasis>, except that it\r
1903 provides "terminator" semantics instead of "separator" semantics. In\r
1904 other words, each commit has the message terminator character (usually a\r
1905 newline) appended, rather than a separator placed between entries.\r
1906 This means that the final entry of a single-line format will be properly\r
1907 terminated with a new line, just as the "oneline" format does.\r
1908 For example:</simpara>\r
1909 <literallayout>$ git log -2 --pretty=format:%h 4da45bef \\r
1910   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'\r
1911 4da45be\r
1912 7134973 -- NO NEWLINE\r
1913 \r
1914 $ git log -2 --pretty=tformat:%h 4da45bef \\r
1915   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'\r
1916 4da45be\r
1917 7134973</literallayout>\r
1918 </listitem>\r
1919 </itemizedlist>\r
1920 </simplesect>\r
1921 <simplesect id="_generating_patches_with_p">\r
1922 <title>Generating patches with -p</title>\r
1923 <simpara>When "git-diff-index", "git-diff-tree", or "git-diff-files" are run\r
1924 with a <emphasis>-p</emphasis> option, "git diff" without the <emphasis>--raw</emphasis> option, or\r
1925 "git log" with the "-p" option, they\r
1926 do not produce the output described above; instead they produce a\r
1927 patch file.  You can customize the creation of such patches via the\r
1928 GIT_EXTERNAL_DIFF and the GIT_DIFF_OPTS environment variables.</simpara>\r
1929 <simpara>What the -p option produces is slightly different from the traditional\r
1930 diff format.</simpara>\r
1931 <orderedlist numeration="arabic">\r
1932 <listitem>\r
1933 <simpara>\r
1934 It is preceded with a "git diff" header, that looks like\r
1935      this:\r
1936 </simpara>\r
1937 <literallayout class="monospaced">diff --git a/file1 b/file2</literallayout>\r
1938 <simpara>The <literal>a/</literal> and <literal>b/</literal> filenames are the same unless rename/copy is\r
1939 involved.  Especially, even for a creation or a deletion,\r
1940 <literal>/dev/null</literal> is <emphasis>not</emphasis> used in place of <literal>a/</literal> or <literal>b/</literal> filenames.</simpara>\r
1941 <simpara>When rename/copy is involved, <literal>file1</literal> and <literal>file2</literal> show the\r
1942 name of the source file of the rename/copy and the name of\r
1943 the file that rename/copy produces, respectively.</simpara>\r
1944 </listitem>\r
1945 <listitem>\r
1946 <simpara>\r
1947 It is followed by one or more extended header lines:\r
1948 </simpara>\r
1949 <literallayout class="monospaced">old mode &lt;mode&gt;\r
1950 new mode &lt;mode&gt;\r
1951 deleted file mode &lt;mode&gt;\r
1952 new file mode &lt;mode&gt;\r
1953 copy from &lt;path&gt;\r
1954 copy to &lt;path&gt;\r
1955 rename from &lt;path&gt;\r
1956 rename to &lt;path&gt;\r
1957 similarity index &lt;number&gt;\r
1958 dissimilarity index &lt;number&gt;\r
1959 index &lt;hash&gt;..&lt;hash&gt; &lt;mode&gt;</literallayout>\r
1960 </listitem>\r
1961 <listitem>\r
1962 <simpara>\r
1963 TAB, LF, double quote and backslash characters in pathnames\r
1964     are represented as <literal>\t</literal>, <literal>\n</literal>, <literal>\"</literal> and <literal>\\</literal>, respectively.\r
1965     If there is need for such substitution then the whole\r
1966     pathname is put in double quotes.\r
1967 </simpara>\r
1968 </listitem>\r
1969 </orderedlist>\r
1970 <simpara>The similarity index is the percentage of unchanged lines, and\r
1971 the dissimilarity index is the percentage of changed lines.  It\r
1972 is a rounded down integer, followed by a percent sign.  The\r
1973 similarity index value of 100% is thus reserved for two equal\r
1974 files, while 100% dissimilarity means that no line from the old\r
1975 file made it into the new one.</simpara>\r
1976 </simplesect>\r
1977 <simplesect id="_combined_diff_format">\r
1978 <title>combined diff format</title>\r
1979 <simpara>"git-diff-tree", "git-diff-files" and "git-diff" can take <emphasis>-c</emphasis> or\r
1980 <emphasis>--cc</emphasis> option to produce <emphasis>combined diff</emphasis>.  For showing a merge commit\r
1981 with "git log -p", this is the default format.\r
1982 A <emphasis>combined diff</emphasis> format looks like this:</simpara>\r
1983 <literallayout>diff --combined describe.c\r
1984 index fabadb8,cc95eb0..4866510\r
1985 --- a/describe.c\r
1986 +++ b/describe.c\r
1987 @@@ -98,20 -98,12 +98,20 @@@\r
1988         return (a_date &gt; b_date) ? -1 : (a_date == b_date) ? 0 : 1;\r
1989   }\r
1990 \r
1991 - static void describe(char *arg)\r
1992  -static void describe(struct commit *cmit, int last_one)\r
1993 ++static void describe(char *arg, int last_one)\r
1994   {\r
1995  +      unsigned char sha1[20];\r
1996  +      struct commit *cmit;\r
1997         struct commit_list *list;\r
1998         static int initialized = 0;\r
1999         struct commit_name *n;\r
2000 \r
2001  +      if (get_sha1(arg, sha1) &lt; 0)\r
2002  +              usage(describe_usage);\r
2003  +      cmit = lookup_commit_reference(sha1);\r
2004  +      if (!cmit)\r
2005  +              usage(describe_usage);\r
2006  +\r
2007         if (!initialized) {\r
2008                 initialized = 1;\r
2009                 for_each_ref(get_name);</literallayout>\r
2010 <orderedlist numeration="arabic">\r
2011 <listitem>\r
2012 <simpara>\r
2013 It is preceded with a "git diff" header, that looks like\r
2014      this (when <emphasis>-c</emphasis> option is used):\r
2015 </simpara>\r
2016 <literallayout class="monospaced">diff --combined file</literallayout>\r
2017 <simpara>or like this (when <emphasis>--cc</emphasis> option is used):</simpara>\r
2018 <literallayout class="monospaced">diff --cc file</literallayout>\r
2019 </listitem>\r
2020 <listitem>\r
2021 <simpara>\r
2022 It is followed by one or more extended header lines\r
2023      (this example shows a merge with two parents):\r
2024 </simpara>\r
2025 <literallayout class="monospaced">index &lt;hash&gt;,&lt;hash&gt;..&lt;hash&gt;\r
2026 mode &lt;mode&gt;,&lt;mode&gt;..&lt;mode&gt;\r
2027 new file mode &lt;mode&gt;\r
2028 deleted file mode &lt;mode&gt;,&lt;mode&gt;</literallayout>\r
2029 <simpara>The <literal>mode &lt;mode&gt;,&lt;mode&gt;..&lt;mode&gt;</literal> line appears only if at least one of\r
2030 the &lt;mode&gt; is different from the rest. Extended headers with\r
2031 information about detected contents movement (renames and\r
2032 copying detection) are designed to work with diff of two\r
2033 &lt;tree-ish&gt; and are not used by combined diff format.</simpara>\r
2034 </listitem>\r
2035 <listitem>\r
2036 <simpara>\r
2037 It is followed by two-line from-file/to-file header\r
2038 </simpara>\r
2039 <literallayout class="monospaced">--- a/file\r
2040 +++ b/file</literallayout>\r
2041 <simpara>Similar to two-line header for traditional <emphasis>unified</emphasis> diff\r
2042 format, <literal>/dev/null</literal> is used to signal created or deleted\r
2043 files.</simpara>\r
2044 </listitem>\r
2045 <listitem>\r
2046 <simpara>\r
2047 Chunk header format is modified to prevent people from\r
2048      accidentally feeding it to <literal>patch -p1</literal>. Combined diff format\r
2049      was created for review of merge commit changes, and was not\r
2050      meant for apply. The change is similar to the change in the\r
2051      extended <emphasis>index</emphasis> header:\r
2052 </simpara>\r
2053 <literallayout class="monospaced">@@@ &lt;from-file-range&gt; &lt;from-file-range&gt; &lt;to-file-range&gt; @@@</literallayout>\r
2054 <simpara>There are (number of parents + 1) <literal>@</literal> characters in the chunk\r
2055 header for combined diff format.</simpara>\r
2056 </listitem>\r
2057 </orderedlist>\r
2058 <simpara>Unlike the traditional <emphasis>unified</emphasis> diff format, which shows two\r
2059 files A and B with a single column that has <literal>-</literal> (minus&#8201;&#8212;&#8201;appears in A but removed in B), <literal>+</literal> (plus&#8201;&#8212;&#8201;missing in A but\r
2060 added to B), or <literal>" "</literal> (space&#8201;&#8212;&#8201;unchanged) prefix, this format\r
2061 compares two or more files file1, file2,&#8230; with one file X, and\r
2062 shows how X differs from each of fileN.  One column for each of\r
2063 fileN is prepended to the output line to note how X&#8217;s line is\r
2064 different from it.</simpara>\r
2065 <simpara>A <literal>-</literal> character in the column N means that the line appears in\r
2066 fileN but it does not appear in the result.  A <literal>+</literal> character\r
2067 in the column N means that the line appears in the result,\r
2068 and fileN does not have that line (in other words, the line was\r
2069 added, from the point of view of that parent).</simpara>\r
2070 <simpara>In the above example output, the function signature was changed\r
2071 from both files (hence two <literal>-</literal> removals from both file1 and\r
2072 file2, plus <literal>++</literal> to mean one line that was added does not appear\r
2073 in either file1 nor file2).  Also eight other lines are the same\r
2074 from file1 but do not appear in file2 (hence prefixed with <literal>&#43;</literal>).</simpara>\r
2075 <simpara>When shown by <literal>git diff-tree -c</literal>, it compares the parents of a\r
2076 merge commit with the merge result (i.e. file1..fileN are the\r
2077 parents).  When shown by <literal>git diff-files -c</literal>, it compares the\r
2078 two unresolved merge parents with the working tree file\r
2079 (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka\r
2080 "their version").</simpara>\r
2081 </simplesect>\r
2082 <simplesect id="_examples">\r
2083 <title>Examples</title>\r
2084 <variablelist>\r
2085 <varlistentry>\r
2086 <term>\r
2087 git log --no-merges\r
2088 </term>\r
2089 <listitem>\r
2090 <simpara>\r
2091         Show the whole commit history, but skip any merges\r
2092 </simpara>\r
2093 </listitem>\r
2094 </varlistentry>\r
2095 <varlistentry>\r
2096 <term>\r
2097 git log v2.6.12.. include/scsi drivers/scsi\r
2098 </term>\r
2099 <listitem>\r
2100 <simpara>\r
2101         Show all commits since version <emphasis>v2.6.12</emphasis> that changed any file\r
2102         in the include/scsi or drivers/scsi subdirectories\r
2103 </simpara>\r
2104 </listitem>\r
2105 </varlistentry>\r
2106 <varlistentry>\r
2107 <term>\r
2108 git log --since="2 weeks ago" -- gitk\r
2109 </term>\r
2110 <listitem>\r
2111 <simpara>\r
2112         Show the changes during the last two weeks to the file <emphasis>gitk</emphasis>.\r
2113         The "--" is necessary to avoid confusion with the <emphasis role="strong">branch</emphasis> named\r
2114         <emphasis>gitk</emphasis>\r
2115 </simpara>\r
2116 </listitem>\r
2117 </varlistentry>\r
2118 <varlistentry>\r
2119 <term>\r
2120 git log --name-status release..test\r
2121 </term>\r
2122 <listitem>\r
2123 <simpara>\r
2124         Show the commits that are in the "test" branch but not yet\r
2125         in the "release" branch, along with the list of paths\r
2126         each commit modifies.\r
2127 </simpara>\r
2128 </listitem>\r
2129 </varlistentry>\r
2130 <varlistentry>\r
2131 <term>\r
2132 git log --follow builtin-rev-list.c\r
2133 </term>\r
2134 <listitem>\r
2135 <simpara>\r
2136         Shows the commits that changed builtin-rev-list.c, including\r
2137         those commits that occurred before the file was given its\r
2138         present name.\r
2139 </simpara>\r
2140 </listitem>\r
2141 </varlistentry>\r
2142 </variablelist>\r
2143 </simplesect>\r
2144 <simplesect id="_discussion">\r
2145 <title>Discussion</title>\r
2146 <simpara>At the core level, git is character encoding agnostic.</simpara>\r
2147 <itemizedlist>\r
2148 <listitem>\r
2149 <simpara>\r
2150 The pathnames recorded in the index and in the tree objects\r
2151    are treated as uninterpreted sequences of non-NUL bytes.\r
2152    What readdir(2) returns are what are recorded and compared\r
2153    with the data git keeps track of, which in turn are expected\r
2154    to be what lstat(2) and creat(2) accepts.  There is no such\r
2155    thing as pathname encoding translation.\r
2156 </simpara>\r
2157 </listitem>\r
2158 <listitem>\r
2159 <simpara>\r
2160 The contents of the blob objects are uninterpreted sequences\r
2161    of bytes.  There is no encoding translation at the core\r
2162    level.\r
2163 </simpara>\r
2164 </listitem>\r
2165 <listitem>\r
2166 <simpara>\r
2167 The commit log messages are uninterpreted sequences of non-NUL\r
2168    bytes.\r
2169 </simpara>\r
2170 </listitem>\r
2171 </itemizedlist>\r
2172 <simpara>Although we encourage that the commit log messages are encoded\r
2173 in UTF-8, both the core and git Porcelain are designed not to\r
2174 force UTF-8 on projects.  If all participants of a particular\r
2175 project find it more convenient to use legacy encodings, git\r
2176 does not forbid it.  However, there are a few things to keep in\r
2177 mind.</simpara>\r
2178 <orderedlist numeration="arabic">\r
2179 <listitem>\r
2180 <simpara>\r
2181 <emphasis>git-commit</emphasis> and <emphasis>git-commit-tree</emphasis> issues\r
2182   a warning if the commit log message given to it does not look\r
2183   like a valid UTF-8 string, unless you explicitly say your\r
2184   project uses a legacy encoding.  The way to say this is to\r
2185   have i18n.commitencoding in <literal>.git/config</literal> file, like this:\r
2186 </simpara>\r
2187 <literallayout>[i18n]\r
2188         commitencoding = ISO-8859-1</literallayout>\r
2189 <simpara>Commit objects created with the above setting record the value\r
2190 of <literal>i18n.commitencoding</literal> in its <literal>encoding</literal> header.  This is to\r
2191 help other people who look at them later.  Lack of this header\r
2192 implies that the commit log message is encoded in UTF-8.</simpara>\r
2193 </listitem>\r
2194 <listitem>\r
2195 <simpara>\r
2196 <emphasis>git-log</emphasis>, <emphasis>git-show</emphasis>, <emphasis>git-blame</emphasis> and friends look at the\r
2197   <literal>encoding</literal> header of a commit object, and try to re-code the\r
2198   log message into UTF-8 unless otherwise specified.  You can\r
2199   specify the desired output encoding with\r
2200   <literal>i18n.logoutputencoding</literal> in <literal>.git/config</literal> file, like this:\r
2201 </simpara>\r
2202 <literallayout>[i18n]\r
2203         logoutputencoding = ISO-8859-1</literallayout>\r
2204 <simpara>If you do not have this configuration variable, the value of\r
2205 <literal>i18n.commitencoding</literal> is used instead.</simpara>\r
2206 </listitem>\r
2207 </orderedlist>\r
2208 <simpara>Note that we deliberately chose not to re-code the commit log\r
2209 message when a commit is made to force UTF-8 at the commit\r
2210 object level, because re-coding to UTF-8 is not necessarily a\r
2211 reversible operation.</simpara>\r
2212 </simplesect>\r
2213 <simplesect id="_author">\r
2214 <title>Author</title>\r
2215 <simpara>Written by Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt;</simpara>\r
2216 </simplesect>\r
2217 <simplesect id="_documentation">\r
2218 <title>Documentation</title>\r
2219 <simpara>Documentation by David Greaves, Junio C Hamano and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
2220 </simplesect>\r
2221 <simplesect id="_git">\r
2222 <title>GIT</title>\r
2223 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
2224 </simplesect>\r
2225 </article>\r