Autogenerated HTML docs for v2.42.0-241-g6bdb5
[git-htmldocs.git] / git-log.html
blob66de3d04d823452e2eccc9053a637906c48ad016
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5 <head>
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
7 <meta name="generator" content="AsciiDoc 10.2.0" />
8 <title>git-log(1)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
17 /* Title font. */
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
21 #toctitle,
22 #author, #revnumber, #revdate, #revremark,
23 #footer {
24 font-family: Arial,Helvetica,sans-serif;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
49 h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
148 /* Block element titles. */
149 div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
184 div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
210 div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
228 div.imageblock div.content { padding-left: 0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
324 #footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
521 body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 git-log(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-log -
743 Show commit logs
744 </p>
745 </div>
746 </div>
747 <div id="content">
748 <div class="sect1">
749 <h2 id="_synopsis">SYNOPSIS</h2>
750 <div class="sectionbody">
751 <div class="verseblock">
752 <pre class="content"><em>git log</em> [&lt;options&gt;] [&lt;revision-range&gt;] [[--] &lt;path&gt;&#8230;]</pre>
753 <div class="attribution">
754 </div></div>
755 </div>
756 </div>
757 <div class="sect1">
758 <h2 id="_description">DESCRIPTION</h2>
759 <div class="sectionbody">
760 <div class="paragraph"><p>Shows the commit logs.</p></div>
761 <div class="paragraph"><p>List commits that are reachable by following the <code>parent</code> links from the
762 given commit(s), but exclude commits that are reachable from the one(s)
763 given with a <em>&#94;</em> in front of them. The output is given in reverse
764 chronological order by default.</p></div>
765 <div class="paragraph"><p>You can think of this as a set operation. Commits reachable from any of
766 the commits given on the command line form a set, and then commits reachable
767 from any of the ones given with <em>&#94;</em> in front are subtracted from that
768 set. The remaining commits are what comes out in the command&#8217;s output.
769 Various other options and paths parameters can be used to further limit the
770 result.</p></div>
771 <div class="paragraph"><p>Thus, the following command:</p></div>
772 <div class="listingblock">
773 <div class="content">
774 <pre><code>$ git log foo bar ^baz</code></pre>
775 </div></div>
776 <div class="paragraph"><p>means "list all the commits which are reachable from <em>foo</em> or <em>bar</em>, but
777 not from <em>baz</em>".</p></div>
778 <div class="paragraph"><p>A special notation "<em>&lt;commit1&gt;</em>..<em>&lt;commit2&gt;</em>" can be used as a
779 short-hand for "^<em>&lt;commit1&gt;</em> <em>&lt;commit2&gt;</em>". For example, either of
780 the following may be used interchangeably:</p></div>
781 <div class="listingblock">
782 <div class="content">
783 <pre><code>$ git log origin..HEAD
784 $ git log HEAD ^origin</code></pre>
785 </div></div>
786 <div class="paragraph"><p>Another special notation is "<em>&lt;commit1&gt;</em>&#8230;<em>&lt;commit2&gt;</em>" which is useful
787 for merges. The resulting set of commits is the symmetric difference
788 between the two operands. The following two commands are equivalent:</p></div>
789 <div class="listingblock">
790 <div class="content">
791 <pre><code>$ git log A B --not $(git merge-base --all A B)
792 $ git log A...B</code></pre>
793 </div></div>
794 <div class="paragraph"><p>The command takes options applicable to the <a href="git-rev-list.html">git-rev-list(1)</a>
795 command to control what is shown and how, and options applicable to
796 the <a href="git-diff.html">git-diff(1)</a> command to control how the changes
797 each commit introduces are shown.</p></div>
798 </div>
799 </div>
800 <div class="sect1">
801 <h2 id="_options">OPTIONS</h2>
802 <div class="sectionbody">
803 <div class="dlist"><dl>
804 <dt class="hdlist1">
805 --follow
806 </dt>
807 <dd>
809 Continue listing the history of a file beyond renames
810 (works only for a single file).
811 </p>
812 </dd>
813 <dt class="hdlist1">
814 --no-decorate
815 </dt>
816 <dt class="hdlist1">
817 --decorate[=short|full|auto|no]
818 </dt>
819 <dd>
821 Print out the ref names of any commits that are shown. If <em>short</em> is
822 specified, the ref name prefixes <em>refs/heads/</em>, <em>refs/tags/</em> and
823 <em>refs/remotes/</em> will not be printed. If <em>full</em> is specified, the
824 full ref name (including prefix) will be printed. If <em>auto</em> is
825 specified, then if the output is going to a terminal, the ref names
826 are shown as if <em>short</em> were given, otherwise no ref names are
827 shown. The option <code>--decorate</code> is short-hand for <code>--decorate=short</code>.
828 Default to configuration value of <code>log.decorate</code> if configured,
829 otherwise, <code>auto</code>.
830 </p>
831 </dd>
832 <dt class="hdlist1">
833 --decorate-refs=&lt;pattern&gt;
834 </dt>
835 <dt class="hdlist1">
836 --decorate-refs-exclude=&lt;pattern&gt;
837 </dt>
838 <dd>
840 For each candidate reference, do not use it for decoration if it
841 matches any patterns given to <code>--decorate-refs-exclude</code> or if it
842 doesn&#8217;t match any of the patterns given to <code>--decorate-refs</code>. The
843 <code>log.excludeDecoration</code> config option allows excluding refs from
844 the decorations, but an explicit <code>--decorate-refs</code> pattern will
845 override a match in <code>log.excludeDecoration</code>.
846 </p>
847 <div class="paragraph"><p>If none of these options or config settings are given, then references are
848 used as decoration if they match <code>HEAD</code>, <code>refs/heads/</code>, <code>refs/remotes/</code>,
849 <code>refs/stash/</code>, or <code>refs/tags/</code>.</p></div>
850 </dd>
851 <dt class="hdlist1">
852 --clear-decorations
853 </dt>
854 <dd>
856 When specified, this option clears all previous <code>--decorate-refs</code>
857 or <code>--decorate-refs-exclude</code> options and relaxes the default
858 decoration filter to include all references. This option is
859 assumed if the config value <code>log.initialDecorationSet</code> is set to
860 <code>all</code>.
861 </p>
862 </dd>
863 <dt class="hdlist1">
864 --source
865 </dt>
866 <dd>
868 Print out the ref name given on the command line by which each
869 commit was reached.
870 </p>
871 </dd>
872 <dt class="hdlist1">
873 --[no-]mailmap
874 </dt>
875 <dt class="hdlist1">
876 --[no-]use-mailmap
877 </dt>
878 <dd>
880 Use mailmap file to map author and committer names and email
881 addresses to canonical real names and email addresses. See
882 <a href="git-shortlog.html">git-shortlog(1)</a>.
883 </p>
884 </dd>
885 <dt class="hdlist1">
886 --full-diff
887 </dt>
888 <dd>
890 Without this flag, <code>git log -p &lt;path&gt;...</code> shows commits that
891 touch the specified paths, and diffs about the same specified
892 paths. With this, the full diff is shown for commits that touch
893 the specified paths; this means that "&lt;path&gt;&#8230;" limits only
894 commits, and doesn&#8217;t limit diff for those commits.
895 </p>
896 <div class="paragraph"><p>Note that this affects all diff-based output types, e.g. those
897 produced by <code>--stat</code>, etc.</p></div>
898 </dd>
899 <dt class="hdlist1">
900 --log-size
901 </dt>
902 <dd>
904 Include a line &#8220;log size &lt;number&gt;&#8221; in the output for each commit,
905 where &lt;number&gt; is the length of that commit&#8217;s message in bytes.
906 Intended to speed up tools that read log messages from <code>git log</code>
907 output by allowing them to allocate space in advance.
908 </p>
909 </dd>
910 <dt class="hdlist1">
911 -L&lt;start&gt;,&lt;end&gt;:&lt;file&gt;
912 </dt>
913 <dt class="hdlist1">
914 -L:&lt;funcname&gt;:&lt;file&gt;
915 </dt>
916 <dd>
918 Trace the evolution of the line range given by <em>&lt;start&gt;,&lt;end&gt;</em>,
919 or by the function name regex <em>&lt;funcname&gt;</em>, within the <em>&lt;file&gt;</em>. You may
920 not give any pathspec limiters. This is currently limited to
921 a walk starting from a single revision, i.e., you may only
922 give zero or one positive revision arguments, and
923 <em>&lt;start&gt;</em> and <em>&lt;end&gt;</em> (or <em>&lt;funcname&gt;</em>) must exist in the starting revision.
924 You can specify this option more than once. Implies <code>--patch</code>.
925 Patch output can be suppressed using <code>--no-patch</code>, but other diff formats
926 (namely <code>--raw</code>, <code>--numstat</code>, <code>--shortstat</code>, <code>--dirstat</code>, <code>--summary</code>,
927 <code>--name-only</code>, <code>--name-status</code>, <code>--check</code>) are not currently implemented.
928 </p>
929 <div class="paragraph"><p><em>&lt;start&gt;</em> and <em>&lt;end&gt;</em> can take one of these forms:</p></div>
930 <div class="ulist"><ul>
931 <li>
933 number
934 </p>
935 <div class="paragraph"><p>If <em>&lt;start&gt;</em> or <em>&lt;end&gt;</em> is a number, it specifies an
936 absolute line number (lines count from 1).</p></div>
937 </li>
938 <li>
940 <code>/regex/</code>
941 </p>
942 <div class="paragraph"><p>This form will use the first line matching the given
943 POSIX regex. If <em>&lt;start&gt;</em> is a regex, it will search from the end of
944 the previous <code>-L</code> range, if any, otherwise from the start of file.
945 If <em>&lt;start&gt;</em> is <code>^/regex/</code>, it will search from the start of file.
946 If <em>&lt;end&gt;</em> is a regex, it will search
947 starting at the line given by <em>&lt;start&gt;</em>.</p></div>
948 </li>
949 <li>
951 +offset or -offset
952 </p>
953 <div class="paragraph"><p>This is only valid for <em>&lt;end&gt;</em> and will specify a number
954 of lines before or after the line given by <em>&lt;start&gt;</em>.</p></div>
955 </li>
956 </ul></div>
957 <div class="paragraph"><p>If <code>:&lt;funcname&gt;</code> is given in place of <em>&lt;start&gt;</em> and <em>&lt;end&gt;</em>, it is a
958 regular expression that denotes the range from the first funcname line
959 that matches <em>&lt;funcname&gt;</em>, up to the next funcname line. <code>:&lt;funcname&gt;</code>
960 searches from the end of the previous <code>-L</code> range, if any, otherwise
961 from the start of file. <code>^:&lt;funcname&gt;</code> searches from the start of
962 file. The function names are determined in the same way as <code>git diff</code>
963 works out patch hunk headers (see <em>Defining a custom hunk-header</em>
964 in <a href="gitattributes.html">gitattributes(5)</a>).</p></div>
965 </dd>
966 <dt class="hdlist1">
967 &lt;revision-range&gt;
968 </dt>
969 <dd>
971 Show only commits in the specified revision range. When no
972 &lt;revision-range&gt; is specified, it defaults to <code>HEAD</code> (i.e. the
973 whole history leading to the current commit). <code>origin..HEAD</code>
974 specifies all the commits reachable from the current commit
975 (i.e. <code>HEAD</code>), but not from <code>origin</code>. For a complete list of
976 ways to spell &lt;revision-range&gt;, see the <em>Specifying Ranges</em>
977 section of <a href="gitrevisions.html">gitrevisions(7)</a>.
978 </p>
979 </dd>
980 <dt class="hdlist1">
981 [--] &lt;path&gt;&#8230;
982 </dt>
983 <dd>
985 Show only commits that are enough to explain how the files
986 that match the specified paths came to be. See <em>History
987 Simplification</em> below for details and other simplification
988 modes.
989 </p>
990 <div class="paragraph"><p>Paths may need to be prefixed with <code>--</code> to separate them from
991 options or the revision range, when confusion arises.</p></div>
992 </dd>
993 </dl></div>
994 <div class="sect2">
995 <h3 id="_commit_limiting">Commit Limiting</h3>
996 <div class="paragraph"><p>Besides specifying a range of commits that should be listed using the
997 special notations explained in the description, additional commit
998 limiting may be applied.</p></div>
999 <div class="paragraph"><p>Using more options generally further limits the output (e.g.
1000 <code>--since=&lt;date1&gt;</code> limits to commits newer than <code>&lt;date1&gt;</code>, and using it
1001 with <code>--grep=&lt;pattern&gt;</code> further limits to commits whose log message
1002 has a line that matches <code>&lt;pattern&gt;</code>), unless otherwise noted.</p></div>
1003 <div class="paragraph"><p>Note that these are applied before commit
1004 ordering and formatting options, such as <code>--reverse</code>.</p></div>
1005 <div class="dlist"><dl>
1006 <dt class="hdlist1">
1007 -&lt;number&gt;
1008 </dt>
1009 <dt class="hdlist1">
1010 -n &lt;number&gt;
1011 </dt>
1012 <dt class="hdlist1">
1013 --max-count=&lt;number&gt;
1014 </dt>
1015 <dd>
1017 Limit the number of commits to output.
1018 </p>
1019 </dd>
1020 <dt class="hdlist1">
1021 --skip=&lt;number&gt;
1022 </dt>
1023 <dd>
1025 Skip <em>number</em> commits before starting to show the commit output.
1026 </p>
1027 </dd>
1028 <dt class="hdlist1">
1029 --since=&lt;date&gt;
1030 </dt>
1031 <dt class="hdlist1">
1032 --after=&lt;date&gt;
1033 </dt>
1034 <dd>
1036 Show commits more recent than a specific date.
1037 </p>
1038 </dd>
1039 <dt class="hdlist1">
1040 --since-as-filter=&lt;date&gt;
1041 </dt>
1042 <dd>
1044 Show all commits more recent than a specific date. This visits
1045 all commits in the range, rather than stopping at the first commit which
1046 is older than a specific date.
1047 </p>
1048 </dd>
1049 <dt class="hdlist1">
1050 --until=&lt;date&gt;
1051 </dt>
1052 <dt class="hdlist1">
1053 --before=&lt;date&gt;
1054 </dt>
1055 <dd>
1057 Show commits older than a specific date.
1058 </p>
1059 </dd>
1060 <dt class="hdlist1">
1061 --author=&lt;pattern&gt;
1062 </dt>
1063 <dt class="hdlist1">
1064 --committer=&lt;pattern&gt;
1065 </dt>
1066 <dd>
1068 Limit the commits output to ones with author/committer
1069 header lines that match the specified pattern (regular
1070 expression). With more than one <code>--author=&lt;pattern&gt;</code>,
1071 commits whose author matches any of the given patterns are
1072 chosen (similarly for multiple <code>--committer=&lt;pattern&gt;</code>).
1073 </p>
1074 </dd>
1075 <dt class="hdlist1">
1076 --grep-reflog=&lt;pattern&gt;
1077 </dt>
1078 <dd>
1080 Limit the commits output to ones with reflog entries that
1081 match the specified pattern (regular expression). With
1082 more than one <code>--grep-reflog</code>, commits whose reflog message
1083 matches any of the given patterns are chosen. It is an
1084 error to use this option unless <code>--walk-reflogs</code> is in use.
1085 </p>
1086 </dd>
1087 <dt class="hdlist1">
1088 --grep=&lt;pattern&gt;
1089 </dt>
1090 <dd>
1092 Limit the commits output to ones with log message that
1093 matches the specified pattern (regular expression). With
1094 more than one <code>--grep=&lt;pattern&gt;</code>, commits whose message
1095 matches any of the given patterns are chosen (but see
1096 <code>--all-match</code>).
1097 </p>
1098 <div class="paragraph"><p>When <code>--notes</code> is in effect, the message from the notes is
1099 matched as if it were part of the log message.</p></div>
1100 </dd>
1101 <dt class="hdlist1">
1102 --all-match
1103 </dt>
1104 <dd>
1106 Limit the commits output to ones that match all given <code>--grep</code>,
1107 instead of ones that match at least one.
1108 </p>
1109 </dd>
1110 <dt class="hdlist1">
1111 --invert-grep
1112 </dt>
1113 <dd>
1115 Limit the commits output to ones with log message that do not
1116 match the pattern specified with <code>--grep=&lt;pattern&gt;</code>.
1117 </p>
1118 </dd>
1119 <dt class="hdlist1">
1121 </dt>
1122 <dt class="hdlist1">
1123 --regexp-ignore-case
1124 </dt>
1125 <dd>
1127 Match the regular expression limiting patterns without regard to letter
1128 case.
1129 </p>
1130 </dd>
1131 <dt class="hdlist1">
1132 --basic-regexp
1133 </dt>
1134 <dd>
1136 Consider the limiting patterns to be basic regular expressions;
1137 this is the default.
1138 </p>
1139 </dd>
1140 <dt class="hdlist1">
1142 </dt>
1143 <dt class="hdlist1">
1144 --extended-regexp
1145 </dt>
1146 <dd>
1148 Consider the limiting patterns to be extended regular expressions
1149 instead of the default basic regular expressions.
1150 </p>
1151 </dd>
1152 <dt class="hdlist1">
1154 </dt>
1155 <dt class="hdlist1">
1156 --fixed-strings
1157 </dt>
1158 <dd>
1160 Consider the limiting patterns to be fixed strings (don&#8217;t interpret
1161 pattern as a regular expression).
1162 </p>
1163 </dd>
1164 <dt class="hdlist1">
1166 </dt>
1167 <dt class="hdlist1">
1168 --perl-regexp
1169 </dt>
1170 <dd>
1172 Consider the limiting patterns to be Perl-compatible regular
1173 expressions.
1174 </p>
1175 <div class="paragraph"><p>Support for these types of regular expressions is an optional
1176 compile-time dependency. If Git wasn&#8217;t compiled with support for them
1177 providing this option will cause it to die.</p></div>
1178 </dd>
1179 <dt class="hdlist1">
1180 --remove-empty
1181 </dt>
1182 <dd>
1184 Stop when a given path disappears from the tree.
1185 </p>
1186 </dd>
1187 <dt class="hdlist1">
1188 --merges
1189 </dt>
1190 <dd>
1192 Print only merge commits. This is exactly the same as <code>--min-parents=2</code>.
1193 </p>
1194 </dd>
1195 <dt class="hdlist1">
1196 --no-merges
1197 </dt>
1198 <dd>
1200 Do not print commits with more than one parent. This is
1201 exactly the same as <code>--max-parents=1</code>.
1202 </p>
1203 </dd>
1204 <dt class="hdlist1">
1205 --min-parents=&lt;number&gt;
1206 </dt>
1207 <dt class="hdlist1">
1208 --max-parents=&lt;number&gt;
1209 </dt>
1210 <dt class="hdlist1">
1211 --no-min-parents
1212 </dt>
1213 <dt class="hdlist1">
1214 --no-max-parents
1215 </dt>
1216 <dd>
1218 Show only commits which have at least (or at most) that many parent
1219 commits. In particular, <code>--max-parents=1</code> is the same as <code>--no-merges</code>,
1220 <code>--min-parents=2</code> is the same as <code>--merges</code>. <code>--max-parents=0</code>
1221 gives all root commits and <code>--min-parents=3</code> all octopus merges.
1222 </p>
1223 <div class="paragraph"><p><code>--no-min-parents</code> and <code>--no-max-parents</code> reset these limits (to no limit)
1224 again. Equivalent forms are <code>--min-parents=0</code> (any commit has 0 or more
1225 parents) and <code>--max-parents=-1</code> (negative numbers denote no upper limit).</p></div>
1226 </dd>
1227 <dt class="hdlist1">
1228 --first-parent
1229 </dt>
1230 <dd>
1232 When finding commits to include, follow only the first
1233 parent commit upon seeing a merge commit. This option
1234 can give a better overview when viewing the evolution of
1235 a particular topic branch, because merges into a topic
1236 branch tend to be only about adjusting to updated upstream
1237 from time to time, and this option allows you to ignore
1238 the individual commits brought in to your history by such
1239 a merge.
1240 </p>
1241 <div class="paragraph"><p>This option also changes default diff format for merge commits
1242 to <code>first-parent</code>, see <code>--diff-merges=first-parent</code> for details.</p></div>
1243 </dd>
1244 <dt class="hdlist1">
1245 --exclude-first-parent-only
1246 </dt>
1247 <dd>
1249 When finding commits to exclude (with a <em>&#94;</em>), follow only
1250 the first parent commit upon seeing a merge commit.
1251 This can be used to find the set of changes in a topic branch
1252 from the point where it diverged from the remote branch, given
1253 that arbitrary merges can be valid topic branch changes.
1254 </p>
1255 </dd>
1256 <dt class="hdlist1">
1257 --not
1258 </dt>
1259 <dd>
1261 Reverses the meaning of the <em>&#94;</em> prefix (or lack thereof)
1262 for all following revision specifiers, up to the next <code>--not</code>.
1263 </p>
1264 </dd>
1265 <dt class="hdlist1">
1266 --all
1267 </dt>
1268 <dd>
1270 Pretend as if all the refs in <code>refs/</code>, along with <code>HEAD</code>, are
1271 listed on the command line as <em>&lt;commit&gt;</em>.
1272 </p>
1273 </dd>
1274 <dt class="hdlist1">
1275 --branches[=&lt;pattern&gt;]
1276 </dt>
1277 <dd>
1279 Pretend as if all the refs in <code>refs/heads</code> are listed
1280 on the command line as <em>&lt;commit&gt;</em>. If <em>&lt;pattern&gt;</em> is given, limit
1281 branches to ones matching given shell glob. If pattern lacks <em>?</em>,
1282 <em>&#42;</em>, or <em>[</em>, <em>/&#42;</em> at the end is implied.
1283 </p>
1284 </dd>
1285 <dt class="hdlist1">
1286 --tags[=&lt;pattern&gt;]
1287 </dt>
1288 <dd>
1290 Pretend as if all the refs in <code>refs/tags</code> are listed
1291 on the command line as <em>&lt;commit&gt;</em>. If <em>&lt;pattern&gt;</em> is given, limit
1292 tags to ones matching given shell glob. If pattern lacks <em>?</em>, <em>&#42;</em>,
1293 or <em>[</em>, <em>/&#42;</em> at the end is implied.
1294 </p>
1295 </dd>
1296 <dt class="hdlist1">
1297 --remotes[=&lt;pattern&gt;]
1298 </dt>
1299 <dd>
1301 Pretend as if all the refs in <code>refs/remotes</code> are listed
1302 on the command line as <em>&lt;commit&gt;</em>. If <em>&lt;pattern&gt;</em> is given, limit
1303 remote-tracking branches to ones matching given shell glob.
1304 If pattern lacks <em>?</em>, <em>&#42;</em>, or <em>[</em>, <em>/&#42;</em> at the end is implied.
1305 </p>
1306 </dd>
1307 <dt class="hdlist1">
1308 --glob=&lt;glob-pattern&gt;
1309 </dt>
1310 <dd>
1312 Pretend as if all the refs matching shell glob <em>&lt;glob-pattern&gt;</em>
1313 are listed on the command line as <em>&lt;commit&gt;</em>. Leading <em>refs/</em>,
1314 is automatically prepended if missing. If pattern lacks <em>?</em>, <em>&#42;</em>,
1315 or <em>[</em>, <em>/&#42;</em> at the end is implied.
1316 </p>
1317 </dd>
1318 <dt class="hdlist1">
1319 --exclude=&lt;glob-pattern&gt;
1320 </dt>
1321 <dd>
1323 Do not include refs matching <em>&lt;glob-pattern&gt;</em> that the next <code>--all</code>,
1324 <code>--branches</code>, <code>--tags</code>, <code>--remotes</code>, or <code>--glob</code> would otherwise
1325 consider. Repetitions of this option accumulate exclusion patterns
1326 up to the next <code>--all</code>, <code>--branches</code>, <code>--tags</code>, <code>--remotes</code>, or
1327 <code>--glob</code> option (other options or arguments do not clear
1328 accumulated patterns).
1329 </p>
1330 <div class="paragraph"><p>The patterns given should not begin with <code>refs/heads</code>, <code>refs/tags</code>, or
1331 <code>refs/remotes</code> when applied to <code>--branches</code>, <code>--tags</code>, or <code>--remotes</code>,
1332 respectively, and they must begin with <code>refs/</code> when applied to <code>--glob</code>
1333 or <code>--all</code>. If a trailing <em>/&#42;</em> is intended, it must be given
1334 explicitly.</p></div>
1335 </dd>
1336 <dt class="hdlist1">
1337 --exclude-hidden=[fetch|receive|uploadpack]
1338 </dt>
1339 <dd>
1341 Do not include refs that would be hidden by <code>git-fetch</code>,
1342 <code>git-receive-pack</code> or <code>git-upload-pack</code> by consulting the appropriate
1343 <code>fetch.hideRefs</code>, <code>receive.hideRefs</code> or <code>uploadpack.hideRefs</code>
1344 configuration along with <code>transfer.hideRefs</code> (see
1345 <a href="git-config.html">git-config(1)</a>). This option affects the next pseudo-ref option
1346 <code>--all</code> or <code>--glob</code> and is cleared after processing them.
1347 </p>
1348 </dd>
1349 <dt class="hdlist1">
1350 --reflog
1351 </dt>
1352 <dd>
1354 Pretend as if all objects mentioned by reflogs are listed on the
1355 command line as <code>&lt;commit&gt;</code>.
1356 </p>
1357 </dd>
1358 <dt class="hdlist1">
1359 --alternate-refs
1360 </dt>
1361 <dd>
1363 Pretend as if all objects mentioned as ref tips of alternate
1364 repositories were listed on the command line. An alternate
1365 repository is any repository whose object directory is specified
1366 in <code>objects/info/alternates</code>. The set of included objects may
1367 be modified by <code>core.alternateRefsCommand</code>, etc. See
1368 <a href="git-config.html">git-config(1)</a>.
1369 </p>
1370 </dd>
1371 <dt class="hdlist1">
1372 --single-worktree
1373 </dt>
1374 <dd>
1376 By default, all working trees will be examined by the
1377 following options when there are more than one (see
1378 <a href="git-worktree.html">git-worktree(1)</a>): <code>--all</code>, <code>--reflog</code> and
1379 <code>--indexed-objects</code>.
1380 This option forces them to examine the current working tree
1381 only.
1382 </p>
1383 </dd>
1384 <dt class="hdlist1">
1385 --ignore-missing
1386 </dt>
1387 <dd>
1389 Upon seeing an invalid object name in the input, pretend as if
1390 the bad input was not given.
1391 </p>
1392 </dd>
1393 <dt class="hdlist1">
1394 --bisect
1395 </dt>
1396 <dd>
1398 Pretend as if the bad bisection ref <code>refs/bisect/bad</code>
1399 was listed and as if it was followed by <code>--not</code> and the good
1400 bisection refs <code>refs/bisect/good-*</code> on the command
1401 line.
1402 </p>
1403 </dd>
1404 <dt class="hdlist1">
1405 --stdin
1406 </dt>
1407 <dd>
1409 In addition to getting arguments from the command line, read
1410 them from standard input as well. This accepts commits and
1411 pseudo-options like <code>--all</code> and <code>--glob=</code>. When a <code>--</code> separator
1412 is seen, the following input is treated as paths and used to
1413 limit the result.
1414 </p>
1415 </dd>
1416 <dt class="hdlist1">
1417 --cherry-mark
1418 </dt>
1419 <dd>
1421 Like <code>--cherry-pick</code> (see below) but mark equivalent commits
1422 with <code>=</code> rather than omitting them, and inequivalent ones with <code>+</code>.
1423 </p>
1424 </dd>
1425 <dt class="hdlist1">
1426 --cherry-pick
1427 </dt>
1428 <dd>
1430 Omit any commit that introduces the same change as
1431 another commit on the &#8220;other side&#8221; when the set of
1432 commits are limited with symmetric difference.
1433 </p>
1434 <div class="paragraph"><p>For example, if you have two branches, <code>A</code> and <code>B</code>, a usual way
1435 to list all commits on only one side of them is with
1436 <code>--left-right</code> (see the example below in the description of
1437 the <code>--left-right</code> option). However, it shows the commits that were
1438 cherry-picked from the other branch (for example, &#8220;3rd on b&#8221; may be
1439 cherry-picked from branch A). With this option, such pairs of commits are
1440 excluded from the output.</p></div>
1441 </dd>
1442 <dt class="hdlist1">
1443 --left-only
1444 </dt>
1445 <dt class="hdlist1">
1446 --right-only
1447 </dt>
1448 <dd>
1450 List only commits on the respective side of a symmetric difference,
1451 i.e. only those which would be marked <code>&lt;</code> resp. <code>&gt;</code> by
1452 <code>--left-right</code>.
1453 </p>
1454 <div class="paragraph"><p>For example, <code>--cherry-pick --right-only A...B</code> omits those
1455 commits from <code>B</code> which are in <code>A</code> or are patch-equivalent to a commit in
1456 <code>A</code>. In other words, this lists the <code>+</code> commits from <code>git cherry A B</code>.
1457 More precisely, <code>--cherry-pick --right-only --no-merges</code> gives the exact
1458 list.</p></div>
1459 </dd>
1460 <dt class="hdlist1">
1461 --cherry
1462 </dt>
1463 <dd>
1465 A synonym for <code>--right-only --cherry-mark --no-merges</code>; useful to
1466 limit the output to the commits on our side and mark those that
1467 have been applied to the other side of a forked history with
1468 <code>git log --cherry upstream...mybranch</code>, similar to
1469 <code>git cherry upstream mybranch</code>.
1470 </p>
1471 </dd>
1472 <dt class="hdlist1">
1474 </dt>
1475 <dt class="hdlist1">
1476 --walk-reflogs
1477 </dt>
1478 <dd>
1480 Instead of walking the commit ancestry chain, walk
1481 reflog entries from the most recent one to older ones.
1482 When this option is used you cannot specify commits to
1483 exclude (that is, <em>&#94;commit</em>, <em>commit1..commit2</em>,
1484 and <em>commit1...commit2</em> notations cannot be used).
1485 </p>
1486 <div class="paragraph"><p>With <code>--pretty</code> format other than <code>oneline</code> and <code>reference</code> (for obvious reasons),
1487 this causes the output to have two extra lines of information
1488 taken from the reflog. The reflog designator in the output may be shown
1489 as <code>ref@{Nth}</code> (where <code>Nth</code> is the reverse-chronological index in the
1490 reflog) or as <code>ref@{timestamp}</code> (with the timestamp for that entry),
1491 depending on a few rules:</p></div>
1492 <div class="openblock">
1493 <div class="content">
1494 <div class="olist arabic"><ol class="arabic">
1495 <li>
1497 If the starting point is specified as <code>ref@{Nth}</code>, show the index
1498 format.
1499 </p>
1500 </li>
1501 <li>
1503 If the starting point was specified as <code>ref@{now}</code>, show the
1504 timestamp format.
1505 </p>
1506 </li>
1507 <li>
1509 If neither was used, but <code>--date</code> was given on the command line, show
1510 the timestamp in the format requested by <code>--date</code>.
1511 </p>
1512 </li>
1513 <li>
1515 Otherwise, show the index format.
1516 </p>
1517 </li>
1518 </ol></div>
1519 </div></div>
1520 <div class="paragraph"><p>Under <code>--pretty=oneline</code>, the commit message is
1521 prefixed with this information on the same line.
1522 This option cannot be combined with <code>--reverse</code>.
1523 See also <a href="git-reflog.html">git-reflog(1)</a>.</p></div>
1524 <div class="paragraph"><p>Under <code>--pretty=reference</code>, this information will not be shown at all.</p></div>
1525 </dd>
1526 <dt class="hdlist1">
1527 --merge
1528 </dt>
1529 <dd>
1531 After a failed merge, show refs that touch files having a
1532 conflict and don&#8217;t exist on all heads to merge.
1533 </p>
1534 </dd>
1535 <dt class="hdlist1">
1536 --boundary
1537 </dt>
1538 <dd>
1540 Output excluded boundary commits. Boundary commits are
1541 prefixed with <code>-</code>.
1542 </p>
1543 </dd>
1544 </dl></div>
1545 </div>
1546 <div class="sect2">
1547 <h3 id="_history_simplification">History Simplification</h3>
1548 <div class="paragraph"><p>Sometimes you are only interested in parts of the history, for example the
1549 commits modifying a particular &lt;path&gt;. But there are two parts of
1550 <em>History Simplification</em>, one part is selecting the commits and the other
1551 is how to do it, as there are various strategies to simplify the history.</p></div>
1552 <div class="paragraph"><p>The following options select the commits to be shown:</p></div>
1553 <div class="dlist"><dl>
1554 <dt class="hdlist1">
1555 &lt;paths&gt;
1556 </dt>
1557 <dd>
1559 Commits modifying the given &lt;paths&gt; are selected.
1560 </p>
1561 </dd>
1562 <dt class="hdlist1">
1563 --simplify-by-decoration
1564 </dt>
1565 <dd>
1567 Commits that are referred by some branch or tag are selected.
1568 </p>
1569 </dd>
1570 </dl></div>
1571 <div class="paragraph"><p>Note that extra commits can be shown to give a meaningful history.</p></div>
1572 <div class="paragraph"><p>The following options affect the way the simplification is performed:</p></div>
1573 <div class="dlist"><dl>
1574 <dt class="hdlist1">
1575 Default mode
1576 </dt>
1577 <dd>
1579 Simplifies the history to the simplest history explaining the
1580 final state of the tree. Simplest because it prunes some side
1581 branches if the end result is the same (i.e. merging branches
1582 with the same content)
1583 </p>
1584 </dd>
1585 <dt class="hdlist1">
1586 --show-pulls
1587 </dt>
1588 <dd>
1590 Include all commits from the default mode, but also any merge
1591 commits that are not TREESAME to the first parent but are
1592 TREESAME to a later parent. This mode is helpful for showing
1593 the merge commits that "first introduced" a change to a branch.
1594 </p>
1595 </dd>
1596 <dt class="hdlist1">
1597 --full-history
1598 </dt>
1599 <dd>
1601 Same as the default mode, but does not prune some history.
1602 </p>
1603 </dd>
1604 <dt class="hdlist1">
1605 --dense
1606 </dt>
1607 <dd>
1609 Only the selected commits are shown, plus some to have a
1610 meaningful history.
1611 </p>
1612 </dd>
1613 <dt class="hdlist1">
1614 --sparse
1615 </dt>
1616 <dd>
1618 All commits in the simplified history are shown.
1619 </p>
1620 </dd>
1621 <dt class="hdlist1">
1622 --simplify-merges
1623 </dt>
1624 <dd>
1626 Additional option to <code>--full-history</code> to remove some needless
1627 merges from the resulting history, as there are no selected
1628 commits contributing to this merge.
1629 </p>
1630 </dd>
1631 <dt class="hdlist1">
1632 --ancestry-path[=&lt;commit&gt;]
1633 </dt>
1634 <dd>
1636 When given a range of commits to display (e.g. <em>commit1..commit2</em>
1637 or <em>commit2 &#94;commit1</em>), only display commits in that range
1638 that are ancestors of &lt;commit&gt;, descendants of &lt;commit&gt;, or
1639 &lt;commit&gt; itself. If no commit is specified, use <em>commit1</em> (the
1640 excluded part of the range) as &lt;commit&gt;. Can be passed multiple
1641 times; if so, a commit is included if it is any of the commits
1642 given or if it is an ancestor or descendant of one of them.
1643 </p>
1644 </dd>
1645 </dl></div>
1646 <div class="paragraph"><p>A more detailed explanation follows.</p></div>
1647 <div class="paragraph"><p>Suppose you specified <code>foo</code> as the &lt;paths&gt;. We shall call commits
1648 that modify <code>foo</code> !TREESAME, and the rest TREESAME. (In a diff
1649 filtered for <code>foo</code>, they look different and equal, respectively.)</p></div>
1650 <div class="paragraph"><p>In the following, we will always refer to the same example history to
1651 illustrate the differences between simplification settings. We assume
1652 that you are filtering for a file <code>foo</code> in this commit graph:</p></div>
1653 <div class="listingblock">
1654 <div class="content">
1655 <pre><code> .-A---M---N---O---P---Q
1656 / / / / / /
1657 I B C D E Y
1658 \ / / / / /
1659 `-------------' X</code></pre>
1660 </div></div>
1661 <div class="paragraph"><p>The horizontal line of history A---Q is taken to be the first parent of
1662 each merge. The commits are:</p></div>
1663 <div class="ulist"><ul>
1664 <li>
1666 <code>I</code> is the initial commit, in which <code>foo</code> exists with contents
1667 &#8220;asdf&#8221;, and a file <code>quux</code> exists with contents &#8220;quux&#8221;. Initial
1668 commits are compared to an empty tree, so <code>I</code> is !TREESAME.
1669 </p>
1670 </li>
1671 <li>
1673 In <code>A</code>, <code>foo</code> contains just &#8220;foo&#8221;.
1674 </p>
1675 </li>
1676 <li>
1678 <code>B</code> contains the same change as <code>A</code>. Its merge <code>M</code> is trivial and
1679 hence TREESAME to all parents.
1680 </p>
1681 </li>
1682 <li>
1684 <code>C</code> does not change <code>foo</code>, but its merge <code>N</code> changes it to &#8220;foobar&#8221;,
1685 so it is not TREESAME to any parent.
1686 </p>
1687 </li>
1688 <li>
1690 <code>D</code> sets <code>foo</code> to &#8220;baz&#8221;. Its merge <code>O</code> combines the strings from
1691 <code>N</code> and <code>D</code> to &#8220;foobarbaz&#8221;; i.e., it is not TREESAME to any parent.
1692 </p>
1693 </li>
1694 <li>
1696 <code>E</code> changes <code>quux</code> to &#8220;xyzzy&#8221;, and its merge <code>P</code> combines the
1697 strings to &#8220;quux xyzzy&#8221;. <code>P</code> is TREESAME to <code>O</code>, but not to <code>E</code>.
1698 </p>
1699 </li>
1700 <li>
1702 <code>X</code> is an independent root commit that added a new file <code>side</code>, and <code>Y</code>
1703 modified it. <code>Y</code> is TREESAME to <code>X</code>. Its merge <code>Q</code> added <code>side</code> to <code>P</code>, and
1704 <code>Q</code> is TREESAME to <code>P</code>, but not to <code>Y</code>.
1705 </p>
1706 </li>
1707 </ul></div>
1708 <div class="paragraph"><p><code>rev-list</code> walks backwards through history, including or excluding
1709 commits based on whether <code>--full-history</code> and/or parent rewriting
1710 (via <code>--parents</code> or <code>--children</code>) are used. The following settings
1711 are available.</p></div>
1712 <div class="dlist"><dl>
1713 <dt class="hdlist1">
1714 Default mode
1715 </dt>
1716 <dd>
1718 Commits are included if they are not TREESAME to any parent
1719 (though this can be changed, see <code>--sparse</code> below). If the
1720 commit was a merge, and it was TREESAME to one parent, follow
1721 only that parent. (Even if there are several TREESAME
1722 parents, follow only one of them.) Otherwise, follow all
1723 parents.
1724 </p>
1725 <div class="paragraph"><p>This results in:</p></div>
1726 <div class="listingblock">
1727 <div class="content">
1728 <pre><code> .-A---N---O
1729 / / /
1730 I---------D</code></pre>
1731 </div></div>
1732 <div class="paragraph"><p>Note how the rule to only follow the TREESAME parent, if one is
1733 available, removed <code>B</code> from consideration entirely. <code>C</code> was
1734 considered via <code>N</code>, but is TREESAME. Root commits are compared to an
1735 empty tree, so <code>I</code> is !TREESAME.</p></div>
1736 <div class="paragraph"><p>Parent/child relations are only visible with <code>--parents</code>, but that does
1737 not affect the commits selected in default mode, so we have shown the
1738 parent lines.</p></div>
1739 </dd>
1740 <dt class="hdlist1">
1741 --full-history without parent rewriting
1742 </dt>
1743 <dd>
1745 This mode differs from the default in one point: always follow
1746 all parents of a merge, even if it is TREESAME to one of them.
1747 Even if more than one side of the merge has commits that are
1748 included, this does not imply that the merge itself is! In
1749 the example, we get
1750 </p>
1751 <div class="listingblock">
1752 <div class="content">
1753 <pre><code> I A B N D O P Q</code></pre>
1754 </div></div>
1755 <div class="paragraph"><p><code>M</code> was excluded because it is TREESAME to both parents. <code>E</code>,
1756 <code>C</code> and <code>B</code> were all walked, but only <code>B</code> was !TREESAME, so the others
1757 do not appear.</p></div>
1758 <div class="paragraph"><p>Note that without parent rewriting, it is not really possible to talk
1759 about the parent/child relationships between the commits, so we show
1760 them disconnected.</p></div>
1761 </dd>
1762 <dt class="hdlist1">
1763 --full-history with parent rewriting
1764 </dt>
1765 <dd>
1767 Ordinary commits are only included if they are !TREESAME
1768 (though this can be changed, see <code>--sparse</code> below).
1769 </p>
1770 <div class="paragraph"><p>Merges are always included. However, their parent list is rewritten:
1771 Along each parent, prune away commits that are not included
1772 themselves. This results in</p></div>
1773 <div class="listingblock">
1774 <div class="content">
1775 <pre><code> .-A---M---N---O---P---Q
1776 / / / / /
1777 I B / D /
1778 \ / / / /
1779 `-------------'</code></pre>
1780 </div></div>
1781 <div class="paragraph"><p>Compare to <code>--full-history</code> without rewriting above. Note that <code>E</code>
1782 was pruned away because it is TREESAME, but the parent list of P was
1783 rewritten to contain <code>E</code>'s parent <code>I</code>. The same happened for <code>C</code> and
1784 <code>N</code>, and <code>X</code>, <code>Y</code> and <code>Q</code>.</p></div>
1785 </dd>
1786 </dl></div>
1787 <div class="paragraph"><p>In addition to the above settings, you can change whether TREESAME
1788 affects inclusion:</p></div>
1789 <div class="dlist"><dl>
1790 <dt class="hdlist1">
1791 --dense
1792 </dt>
1793 <dd>
1795 Commits that are walked are included if they are not TREESAME
1796 to any parent.
1797 </p>
1798 </dd>
1799 <dt class="hdlist1">
1800 --sparse
1801 </dt>
1802 <dd>
1804 All commits that are walked are included.
1805 </p>
1806 <div class="paragraph"><p>Note that without <code>--full-history</code>, this still simplifies merges: if
1807 one of the parents is TREESAME, we follow only that one, so the other
1808 sides of the merge are never walked.</p></div>
1809 </dd>
1810 <dt class="hdlist1">
1811 --simplify-merges
1812 </dt>
1813 <dd>
1815 First, build a history graph in the same way that
1816 <code>--full-history</code> with parent rewriting does (see above).
1817 </p>
1818 <div class="paragraph"><p>Then simplify each commit <code>C</code> to its replacement <code>C'</code> in the final
1819 history according to the following rules:</p></div>
1820 <div class="openblock">
1821 <div class="content">
1822 <div class="ulist"><ul>
1823 <li>
1825 Set <code>C'</code> to <code>C</code>.
1826 </p>
1827 </li>
1828 <li>
1830 Replace each parent <code>P</code> of <code>C'</code> with its simplification <code>P'</code>. In
1831 the process, drop parents that are ancestors of other parents or that are
1832 root commits TREESAME to an empty tree, and remove duplicates, but take care
1833 to never drop all parents that we are TREESAME to.
1834 </p>
1835 </li>
1836 <li>
1838 If after this parent rewriting, <code>C'</code> is a root or merge commit (has
1839 zero or &gt;1 parents), a boundary commit, or !TREESAME, it remains.
1840 Otherwise, it is replaced with its only parent.
1841 </p>
1842 </li>
1843 </ul></div>
1844 </div></div>
1845 <div class="paragraph"><p>The effect of this is best shown by way of comparing to
1846 <code>--full-history</code> with parent rewriting. The example turns into:</p></div>
1847 <div class="listingblock">
1848 <div class="content">
1849 <pre><code> .-A---M---N---O
1850 / / /
1851 I B D
1852 \ / /
1853 `---------'</code></pre>
1854 </div></div>
1855 <div class="paragraph"><p>Note the major differences in <code>N</code>, <code>P</code>, and <code>Q</code> over <code>--full-history</code>:</p></div>
1856 <div class="openblock">
1857 <div class="content">
1858 <div class="ulist"><ul>
1859 <li>
1861 <code>N</code>'s parent list had <code>I</code> removed, because it is an ancestor of the
1862 other parent <code>M</code>. Still, <code>N</code> remained because it is !TREESAME.
1863 </p>
1864 </li>
1865 <li>
1867 <code>P</code>'s parent list similarly had <code>I</code> removed. <code>P</code> was then
1868 removed completely, because it had one parent and is TREESAME.
1869 </p>
1870 </li>
1871 <li>
1873 <code>Q</code>'s parent list had <code>Y</code> simplified to <code>X</code>. <code>X</code> was then removed, because it
1874 was a TREESAME root. <code>Q</code> was then removed completely, because it had one
1875 parent and is TREESAME.
1876 </p>
1877 </li>
1878 </ul></div>
1879 </div></div>
1880 </dd>
1881 </dl></div>
1882 <div class="paragraph"><p>There is another simplification mode available:</p></div>
1883 <div class="dlist"><dl>
1884 <dt class="hdlist1">
1885 --ancestry-path[=&lt;commit&gt;]
1886 </dt>
1887 <dd>
1889 Limit the displayed commits to those which are an ancestor of
1890 &lt;commit&gt;, or which are a descendant of &lt;commit&gt;, or are &lt;commit&gt;
1891 itself.
1892 </p>
1893 <div class="paragraph"><p>As an example use case, consider the following commit history:</p></div>
1894 <div class="listingblock">
1895 <div class="content">
1896 <pre><code> D---E-------F
1897 / \ \
1898 B---C---G---H---I---J
1900 A-------K---------------L--M</code></pre>
1901 </div></div>
1902 <div class="paragraph"><p>A regular <em>D..M</em> computes the set of commits that are ancestors of <code>M</code>,
1903 but excludes the ones that are ancestors of <code>D</code>. This is useful to see
1904 what happened to the history leading to <code>M</code> since <code>D</code>, in the sense
1905 that &#8220;what does <code>M</code> have that did not exist in <code>D</code>&#8221;. The result in this
1906 example would be all the commits, except <code>A</code> and <code>B</code> (and <code>D</code> itself,
1907 of course).</p></div>
1908 <div class="paragraph"><p>When we want to find out what commits in <code>M</code> are contaminated with the
1909 bug introduced by <code>D</code> and need fixing, however, we might want to view
1910 only the subset of <em>D..M</em> that are actually descendants of <code>D</code>, i.e.
1911 excluding <code>C</code> and <code>K</code>. This is exactly what the <code>--ancestry-path</code>
1912 option does. Applied to the <em>D..M</em> range, it results in:</p></div>
1913 <div class="listingblock">
1914 <div class="content">
1915 <pre><code> E-------F
1917 G---H---I---J
1919 L--M</code></pre>
1920 </div></div>
1921 <div class="paragraph"><p>We can also use <code>--ancestry-path=D</code> instead of <code>--ancestry-path</code> which
1922 means the same thing when applied to the <em>D..M</em> range but is just more
1923 explicit.</p></div>
1924 <div class="paragraph"><p>If we instead are interested in a given topic within this range, and all
1925 commits affected by that topic, we may only want to view the subset of
1926 <code>D..M</code> which contain that topic in their ancestry path. So, using
1927 <code>--ancestry-path=H D..M</code> for example would result in:</p></div>
1928 <div class="listingblock">
1929 <div class="content">
1930 <pre><code> E
1932 G---H---I---J
1934 L--M</code></pre>
1935 </div></div>
1936 <div class="paragraph"><p>Whereas <code>--ancestry-path=K D..M</code> would result in</p></div>
1937 <div class="listingblock">
1938 <div class="content">
1939 <pre><code> K---------------L--M</code></pre>
1940 </div></div>
1941 </dd>
1942 </dl></div>
1943 <div class="paragraph"><p>Before discussing another option, <code>--show-pulls</code>, we need to
1944 create a new example history.</p></div>
1945 <div class="paragraph"><p>A common problem users face when looking at simplified history is that a
1946 commit they know changed a file somehow does not appear in the file&#8217;s
1947 simplified history. Let&#8217;s demonstrate a new example and show how options
1948 such as <code>--full-history</code> and <code>--simplify-merges</code> works in that case:</p></div>
1949 <div class="listingblock">
1950 <div class="content">
1951 <pre><code> .-A---M-----C--N---O---P
1952 / / \ \ \/ / /
1953 I B \ R-'`-Z' /
1954 \ / \/ /
1955 \ / /\ /
1956 `---X--' `---Y--'</code></pre>
1957 </div></div>
1958 <div class="paragraph"><p>For this example, suppose <code>I</code> created <code>file.txt</code> which was modified by
1959 <code>A</code>, <code>B</code>, and <code>X</code> in different ways. The single-parent commits <code>C</code>, <code>Z</code>,
1960 and <code>Y</code> do not change <code>file.txt</code>. The merge commit <code>M</code> was created by
1961 resolving the merge conflict to include both changes from <code>A</code> and <code>B</code>
1962 and hence is not TREESAME to either. The merge commit <code>R</code>, however, was
1963 created by ignoring the contents of <code>file.txt</code> at <code>M</code> and taking only
1964 the contents of <code>file.txt</code> at <code>X</code>. Hence, <code>R</code> is TREESAME to <code>X</code> but not
1965 <code>M</code>. Finally, the natural merge resolution to create <code>N</code> is to take the
1966 contents of <code>file.txt</code> at <code>R</code>, so <code>N</code> is TREESAME to <code>R</code> but not <code>C</code>.
1967 The merge commits <code>O</code> and <code>P</code> are TREESAME to their first parents, but
1968 not to their second parents, <code>Z</code> and <code>Y</code> respectively.</p></div>
1969 <div class="paragraph"><p>When using the default mode, <code>N</code> and <code>R</code> both have a TREESAME parent, so
1970 those edges are walked and the others are ignored. The resulting history
1971 graph is:</p></div>
1972 <div class="listingblock">
1973 <div class="content">
1974 <pre><code> I---X</code></pre>
1975 </div></div>
1976 <div class="paragraph"><p>When using <code>--full-history</code>, Git walks every edge. This will discover
1977 the commits <code>A</code> and <code>B</code> and the merge <code>M</code>, but also will reveal the
1978 merge commits <code>O</code> and <code>P</code>. With parent rewriting, the resulting graph is:</p></div>
1979 <div class="listingblock">
1980 <div class="content">
1981 <pre><code> .-A---M--------N---O---P
1982 / / \ \ \/ / /
1983 I B \ R-'`--' /
1984 \ / \/ /
1985 \ / /\ /
1986 `---X--' `------'</code></pre>
1987 </div></div>
1988 <div class="paragraph"><p>Here, the merge commits <code>O</code> and <code>P</code> contribute extra noise, as they did
1989 not actually contribute a change to <code>file.txt</code>. They only merged a topic
1990 that was based on an older version of <code>file.txt</code>. This is a common
1991 issue in repositories using a workflow where many contributors work in
1992 parallel and merge their topic branches along a single trunk: many
1993 unrelated merges appear in the <code>--full-history</code> results.</p></div>
1994 <div class="paragraph"><p>When using the <code>--simplify-merges</code> option, the commits <code>O</code> and <code>P</code>
1995 disappear from the results. This is because the rewritten second parents
1996 of <code>O</code> and <code>P</code> are reachable from their first parents. Those edges are
1997 removed and then the commits look like single-parent commits that are
1998 TREESAME to their parent. This also happens to the commit <code>N</code>, resulting
1999 in a history view as follows:</p></div>
2000 <div class="listingblock">
2001 <div class="content">
2002 <pre><code> .-A---M--.
2003 / / \
2004 I B R
2005 \ / /
2006 \ / /
2007 `---X--'</code></pre>
2008 </div></div>
2009 <div class="paragraph"><p>In this view, we see all of the important single-parent changes from
2010 <code>A</code>, <code>B</code>, and <code>X</code>. We also see the carefully-resolved merge <code>M</code> and the
2011 not-so-carefully-resolved merge <code>R</code>. This is usually enough information
2012 to determine why the commits <code>A</code> and <code>B</code> "disappeared" from history in
2013 the default view. However, there are a few issues with this approach.</p></div>
2014 <div class="paragraph"><p>The first issue is performance. Unlike any previous option, the
2015 <code>--simplify-merges</code> option requires walking the entire commit history
2016 before returning a single result. This can make the option difficult to
2017 use for very large repositories.</p></div>
2018 <div class="paragraph"><p>The second issue is one of auditing. When many contributors are working
2019 on the same repository, it is important which merge commits introduced
2020 a change into an important branch. The problematic merge <code>R</code> above is
2021 not likely to be the merge commit that was used to merge into an
2022 important branch. Instead, the merge <code>N</code> was used to merge <code>R</code> and <code>X</code>
2023 into the important branch. This commit may have information about why
2024 the change <code>X</code> came to override the changes from <code>A</code> and <code>B</code> in its
2025 commit message.</p></div>
2026 <div class="dlist"><dl>
2027 <dt class="hdlist1">
2028 --show-pulls
2029 </dt>
2030 <dd>
2032 In addition to the commits shown in the default history, show
2033 each merge commit that is not TREESAME to its first parent but
2034 is TREESAME to a later parent.
2035 </p>
2036 <div class="paragraph"><p>When a merge commit is included by <code>--show-pulls</code>, the merge is
2037 treated as if it "pulled" the change from another branch. When using
2038 <code>--show-pulls</code> on this example (and no other options) the resulting
2039 graph is:</p></div>
2040 <div class="listingblock">
2041 <div class="content">
2042 <pre><code> I---X---R---N</code></pre>
2043 </div></div>
2044 <div class="paragraph"><p>Here, the merge commits <code>R</code> and <code>N</code> are included because they pulled
2045 the commits <code>X</code> and <code>R</code> into the base branch, respectively. These
2046 merges are the reason the commits <code>A</code> and <code>B</code> do not appear in the
2047 default history.</p></div>
2048 <div class="paragraph"><p>When <code>--show-pulls</code> is paired with <code>--simplify-merges</code>, the
2049 graph includes all of the necessary information:</p></div>
2050 <div class="listingblock">
2051 <div class="content">
2052 <pre><code> .-A---M--. N
2053 / / \ /
2054 I B R
2055 \ / /
2056 \ / /
2057 `---X--'</code></pre>
2058 </div></div>
2059 <div class="paragraph"><p>Notice that since <code>M</code> is reachable from <code>R</code>, the edge from <code>N</code> to <code>M</code>
2060 was simplified away. However, <code>N</code> still appears in the history as an
2061 important commit because it "pulled" the change <code>R</code> into the main
2062 branch.</p></div>
2063 </dd>
2064 </dl></div>
2065 <div class="paragraph"><p>The <code>--simplify-by-decoration</code> option allows you to view only the
2066 big picture of the topology of the history, by omitting commits
2067 that are not referenced by tags. Commits are marked as !TREESAME
2068 (in other words, kept after history simplification rules described
2069 above) if (1) they are referenced by tags, or (2) they change the
2070 contents of the paths given on the command line. All other
2071 commits are marked as TREESAME (subject to be simplified away).</p></div>
2072 </div>
2073 <div class="sect2">
2074 <h3 id="_commit_ordering">Commit Ordering</h3>
2075 <div class="paragraph"><p>By default, the commits are shown in reverse chronological order.</p></div>
2076 <div class="dlist"><dl>
2077 <dt class="hdlist1">
2078 --date-order
2079 </dt>
2080 <dd>
2082 Show no parents before all of its children are shown, but
2083 otherwise show commits in the commit timestamp order.
2084 </p>
2085 </dd>
2086 <dt class="hdlist1">
2087 --author-date-order
2088 </dt>
2089 <dd>
2091 Show no parents before all of its children are shown, but
2092 otherwise show commits in the author timestamp order.
2093 </p>
2094 </dd>
2095 <dt class="hdlist1">
2096 --topo-order
2097 </dt>
2098 <dd>
2100 Show no parents before all of its children are shown, and
2101 avoid showing commits on multiple lines of history
2102 intermixed.
2103 </p>
2104 <div class="paragraph"><p>For example, in a commit history like this:</p></div>
2105 <div class="listingblock">
2106 <div class="content">
2107 <pre><code> ---1----2----4----7
2109 3----5----6----8---</code></pre>
2110 </div></div>
2111 <div class="paragraph"><p>where the numbers denote the order of commit timestamps, <code>git
2112 rev-list</code> and friends with <code>--date-order</code> show the commits in the
2113 timestamp order: 8 7 6 5 4 3 2 1.</p></div>
2114 <div class="paragraph"><p>With <code>--topo-order</code>, they would show 8 6 5 3 7 4 2 1 (or 8 7 4 2 6 5
2115 3 1); some older commits are shown before newer ones in order to
2116 avoid showing the commits from two parallel development track mixed
2117 together.</p></div>
2118 </dd>
2119 <dt class="hdlist1">
2120 --reverse
2121 </dt>
2122 <dd>
2124 Output the commits chosen to be shown (see Commit Limiting
2125 section above) in reverse order. Cannot be combined with
2126 <code>--walk-reflogs</code>.
2127 </p>
2128 </dd>
2129 </dl></div>
2130 </div>
2131 <div class="sect2">
2132 <h3 id="_object_traversal">Object Traversal</h3>
2133 <div class="paragraph"><p>These options are mostly targeted for packing of Git repositories.</p></div>
2134 <div class="dlist"><dl>
2135 <dt class="hdlist1">
2136 --no-walk[=(sorted|unsorted)]
2137 </dt>
2138 <dd>
2140 Only show the given commits, but do not traverse their ancestors.
2141 This has no effect if a range is specified. If the argument
2142 <code>unsorted</code> is given, the commits are shown in the order they were
2143 given on the command line. Otherwise (if <code>sorted</code> or no argument
2144 was given), the commits are shown in reverse chronological order
2145 by commit time.
2146 Cannot be combined with <code>--graph</code>.
2147 </p>
2148 </dd>
2149 <dt class="hdlist1">
2150 --do-walk
2151 </dt>
2152 <dd>
2154 Overrides a previous <code>--no-walk</code>.
2155 </p>
2156 </dd>
2157 </dl></div>
2158 </div>
2159 <div class="sect2">
2160 <h3 id="_commit_formatting">Commit Formatting</h3>
2161 <div class="dlist"><dl>
2162 <dt class="hdlist1">
2163 --pretty[=&lt;format&gt;]
2164 </dt>
2165 <dt class="hdlist1">
2166 --format=&lt;format&gt;
2167 </dt>
2168 <dd>
2170 Pretty-print the contents of the commit logs in a given format,
2171 where <em>&lt;format&gt;</em> can be one of <em>oneline</em>, <em>short</em>, <em>medium</em>,
2172 <em>full</em>, <em>fuller</em>, <em>reference</em>, <em>email</em>, <em>raw</em>, <em>format:&lt;string&gt;</em>
2173 and <em>tformat:&lt;string&gt;</em>. When <em>&lt;format&gt;</em> is none of the above,
2174 and has <em>%placeholder</em> in it, it acts as if
2175 <em>--pretty=tformat:&lt;format&gt;</em> were given.
2176 </p>
2177 <div class="paragraph"><p>See the "PRETTY FORMATS" section for some additional details for each
2178 format. When <em>=&lt;format&gt;</em> part is omitted, it defaults to <em>medium</em>.</p></div>
2179 <div class="paragraph"><p>Note: you can specify the default pretty format in the repository
2180 configuration (see <a href="git-config.html">git-config(1)</a>).</p></div>
2181 </dd>
2182 <dt class="hdlist1">
2183 --abbrev-commit
2184 </dt>
2185 <dd>
2187 Instead of showing the full 40-byte hexadecimal commit object
2188 name, show a prefix that names the object uniquely.
2189 "--abbrev=&lt;n&gt;" (which also modifies diff output, if it is displayed)
2190 option can be used to specify the minimum length of the prefix.
2191 </p>
2192 <div class="paragraph"><p>This should make "--pretty=oneline" a whole lot more readable for
2193 people using 80-column terminals.</p></div>
2194 </dd>
2195 <dt class="hdlist1">
2196 --no-abbrev-commit
2197 </dt>
2198 <dd>
2200 Show the full 40-byte hexadecimal commit object name. This negates
2201 <code>--abbrev-commit</code>, either explicit or implied by other options such
2202 as "--oneline". It also overrides the <code>log.abbrevCommit</code> variable.
2203 </p>
2204 </dd>
2205 <dt class="hdlist1">
2206 --oneline
2207 </dt>
2208 <dd>
2210 This is a shorthand for "--pretty=oneline --abbrev-commit"
2211 used together.
2212 </p>
2213 </dd>
2214 <dt class="hdlist1">
2215 --encoding=&lt;encoding&gt;
2216 </dt>
2217 <dd>
2219 Commit objects record the character encoding used for the log message
2220 in their encoding header; this option can be used to tell the
2221 command to re-code the commit log message in the encoding
2222 preferred by the user. For non plumbing commands this
2223 defaults to UTF-8. Note that if an object claims to be encoded
2224 in <code>X</code> and we are outputting in <code>X</code>, we will output the object
2225 verbatim; this means that invalid sequences in the original
2226 commit may be copied to the output. Likewise, if iconv(3) fails
2227 to convert the commit, we will quietly output the original
2228 object verbatim.
2229 </p>
2230 </dd>
2231 <dt class="hdlist1">
2232 --expand-tabs=&lt;n&gt;
2233 </dt>
2234 <dt class="hdlist1">
2235 --expand-tabs
2236 </dt>
2237 <dt class="hdlist1">
2238 --no-expand-tabs
2239 </dt>
2240 <dd>
2242 Perform a tab expansion (replace each tab with enough spaces
2243 to fill to the next display column that is multiple of <em>&lt;n&gt;</em>)
2244 in the log message before showing it in the output.
2245 <code>--expand-tabs</code> is a short-hand for <code>--expand-tabs=8</code>, and
2246 <code>--no-expand-tabs</code> is a short-hand for <code>--expand-tabs=0</code>,
2247 which disables tab expansion.
2248 </p>
2249 <div class="paragraph"><p>By default, tabs are expanded in pretty formats that indent the log
2250 message by 4 spaces (i.e. <em>medium</em>, which is the default, <em>full</em>,
2251 and <em>fuller</em>).</p></div>
2252 </dd>
2253 <dt class="hdlist1">
2254 --notes[=&lt;ref&gt;]
2255 </dt>
2256 <dd>
2258 Show the notes (see <a href="git-notes.html">git-notes(1)</a>) that annotate the
2259 commit, when showing the commit log message. This is the default
2260 for <code>git log</code>, <code>git show</code> and <code>git whatchanged</code> commands when
2261 there is no <code>--pretty</code>, <code>--format</code>, or <code>--oneline</code> option given
2262 on the command line.
2263 </p>
2264 <div class="paragraph"><p>By default, the notes shown are from the notes refs listed in the
2265 <code>core.notesRef</code> and <code>notes.displayRef</code> variables (or corresponding
2266 environment overrides). See <a href="git-config.html">git-config(1)</a> for more details.</p></div>
2267 <div class="paragraph"><p>With an optional <em>&lt;ref&gt;</em> argument, use the ref to find the notes
2268 to display. The ref can specify the full refname when it begins
2269 with <code>refs/notes/</code>; when it begins with <code>notes/</code>, <code>refs/</code> and otherwise
2270 <code>refs/notes/</code> is prefixed to form a full name of the ref.</p></div>
2271 <div class="paragraph"><p>Multiple --notes options can be combined to control which notes are
2272 being displayed. Examples: "--notes=foo" will show only notes from
2273 "refs/notes/foo"; "--notes=foo --notes" will show both notes from
2274 "refs/notes/foo" and from the default notes ref(s).</p></div>
2275 </dd>
2276 <dt class="hdlist1">
2277 --no-notes
2278 </dt>
2279 <dd>
2281 Do not show notes. This negates the above <code>--notes</code> option, by
2282 resetting the list of notes refs from which notes are shown.
2283 Options are parsed in the order given on the command line, so e.g.
2284 "--notes --notes=foo --no-notes --notes=bar" will only show notes
2285 from "refs/notes/bar".
2286 </p>
2287 </dd>
2288 <dt class="hdlist1">
2289 --show-notes[=&lt;ref&gt;]
2290 </dt>
2291 <dt class="hdlist1">
2292 --[no-]standard-notes
2293 </dt>
2294 <dd>
2296 These options are deprecated. Use the above --notes/--no-notes
2297 options instead.
2298 </p>
2299 </dd>
2300 <dt class="hdlist1">
2301 --show-signature
2302 </dt>
2303 <dd>
2305 Check the validity of a signed commit object by passing the signature
2306 to <code>gpg --verify</code> and show the output.
2307 </p>
2308 </dd>
2309 <dt class="hdlist1">
2310 --relative-date
2311 </dt>
2312 <dd>
2314 Synonym for <code>--date=relative</code>.
2315 </p>
2316 </dd>
2317 <dt class="hdlist1">
2318 --date=&lt;format&gt;
2319 </dt>
2320 <dd>
2322 Only takes effect for dates shown in human-readable format, such
2323 as when using <code>--pretty</code>. <code>log.date</code> config variable sets a default
2324 value for the log command&#8217;s <code>--date</code> option. By default, dates
2325 are shown in the original time zone (either committer&#8217;s or
2326 author&#8217;s). If <code>-local</code> is appended to the format (e.g.,
2327 <code>iso-local</code>), the user&#8217;s local time zone is used instead.
2328 </p>
2329 <div class="openblock">
2330 <div class="content">
2331 <div class="paragraph"><p><code>--date=relative</code> shows dates relative to the current time,
2332 e.g. &#8220;2 hours ago&#8221;. The <code>-local</code> option has no effect for
2333 <code>--date=relative</code>.</p></div>
2334 <div class="paragraph"><p><code>--date=local</code> is an alias for <code>--date=default-local</code>.</p></div>
2335 <div class="paragraph"><p><code>--date=iso</code> (or <code>--date=iso8601</code>) shows timestamps in a ISO 8601-like format.
2336 The differences to the strict ISO 8601 format are:</p></div>
2337 <div class="ulist"><ul>
2338 <li>
2340 a space instead of the <code>T</code> date/time delimiter
2341 </p>
2342 </li>
2343 <li>
2345 a space between time and time zone
2346 </p>
2347 </li>
2348 <li>
2350 no colon between hours and minutes of the time zone
2351 </p>
2352 </li>
2353 </ul></div>
2354 <div class="paragraph"><p><code>--date=iso-strict</code> (or <code>--date=iso8601-strict</code>) shows timestamps in strict
2355 ISO 8601 format.</p></div>
2356 <div class="paragraph"><p><code>--date=rfc</code> (or <code>--date=rfc2822</code>) shows timestamps in RFC 2822
2357 format, often found in email messages.</p></div>
2358 <div class="paragraph"><p><code>--date=short</code> shows only the date, but not the time, in <code>YYYY-MM-DD</code> format.</p></div>
2359 <div class="paragraph"><p><code>--date=raw</code> shows the date as seconds since the epoch (1970-01-01
2360 00:00:00 UTC), followed by a space, and then the timezone as an offset
2361 from UTC (a <code>+</code> or <code>-</code> with four digits; the first two are hours, and
2362 the second two are minutes). I.e., as if the timestamp were formatted
2363 with <code>strftime("%s %z")</code>).
2364 Note that the <code>-local</code> option does not affect the seconds-since-epoch
2365 value (which is always measured in UTC), but does switch the accompanying
2366 timezone value.</p></div>
2367 <div class="paragraph"><p><code>--date=human</code> shows the timezone if the timezone does not match the
2368 current time-zone, and doesn&#8217;t print the whole date if that matches
2369 (ie skip printing year for dates that are "this year", but also skip
2370 the whole date itself if it&#8217;s in the last few days and we can just say
2371 what weekday it was). For older dates the hour and minute is also
2372 omitted.</p></div>
2373 <div class="paragraph"><p><code>--date=unix</code> shows the date as a Unix epoch timestamp (seconds since
2374 1970). As with <code>--raw</code>, this is always in UTC and therefore <code>-local</code>
2375 has no effect.</p></div>
2376 <div class="paragraph"><p><code>--date=format:...</code> feeds the format <code>...</code> to your system <code>strftime</code>,
2377 except for %s, %z, and %Z, which are handled internally.
2378 Use <code>--date=format:%c</code> to show the date in your system locale&#8217;s
2379 preferred format. See the <code>strftime</code> manual for a complete list of
2380 format placeholders. When using <code>-local</code>, the correct syntax is
2381 <code>--date=format-local:...</code>.</p></div>
2382 <div class="paragraph"><p><code>--date=default</code> is the default format, and is based on ctime(3)
2383 output. It shows a single line with three-letter day of the week,
2384 three-letter month, day-of-month, hour-minute-seconds in "HH:MM:SS"
2385 format, followed by 4-digit year, plus timezone information, unless
2386 the local time zone is used, e.g. <code>Thu Jan 1 00:00:00 1970 +0000</code>.</p></div>
2387 </div></div>
2388 </dd>
2389 <dt class="hdlist1">
2390 --parents
2391 </dt>
2392 <dd>
2394 Print also the parents of the commit (in the form "commit parent&#8230;").
2395 Also enables parent rewriting, see <em>History Simplification</em> above.
2396 </p>
2397 </dd>
2398 <dt class="hdlist1">
2399 --children
2400 </dt>
2401 <dd>
2403 Print also the children of the commit (in the form "commit child&#8230;").
2404 Also enables parent rewriting, see <em>History Simplification</em> above.
2405 </p>
2406 </dd>
2407 <dt class="hdlist1">
2408 --left-right
2409 </dt>
2410 <dd>
2412 Mark which side of a symmetric difference a commit is reachable from.
2413 Commits from the left side are prefixed with <code>&lt;</code> and those from
2414 the right with <code>&gt;</code>. If combined with <code>--boundary</code>, those
2415 commits are prefixed with <code>-</code>.
2416 </p>
2417 <div class="paragraph"><p>For example, if you have this topology:</p></div>
2418 <div class="listingblock">
2419 <div class="content">
2420 <pre><code> y---b---b branch B
2421 / \ /
2423 / / \
2424 o---x---a---a branch A</code></pre>
2425 </div></div>
2426 <div class="paragraph"><p>you would get an output like this:</p></div>
2427 <div class="listingblock">
2428 <div class="content">
2429 <pre><code> $ git rev-list --left-right --boundary --pretty=oneline A...B
2431 &gt;bbbbbbb... 3rd on b
2432 &gt;bbbbbbb... 2nd on b
2433 &lt;aaaaaaa... 3rd on a
2434 &lt;aaaaaaa... 2nd on a
2435 -yyyyyyy... 1st on b
2436 -xxxxxxx... 1st on a</code></pre>
2437 </div></div>
2438 </dd>
2439 <dt class="hdlist1">
2440 --graph
2441 </dt>
2442 <dd>
2444 Draw a text-based graphical representation of the commit history
2445 on the left hand side of the output. This may cause extra lines
2446 to be printed in between commits, in order for the graph history
2447 to be drawn properly.
2448 Cannot be combined with <code>--no-walk</code>.
2449 </p>
2450 <div class="paragraph"><p>This enables parent rewriting, see <em>History Simplification</em> above.</p></div>
2451 <div class="paragraph"><p>This implies the <code>--topo-order</code> option by default, but the
2452 <code>--date-order</code> option may also be specified.</p></div>
2453 </dd>
2454 <dt class="hdlist1">
2455 --show-linear-break[=&lt;barrier&gt;]
2456 </dt>
2457 <dd>
2459 When --graph is not used, all history branches are flattened
2460 which can make it hard to see that the two consecutive commits
2461 do not belong to a linear branch. This option puts a barrier
2462 in between them in that case. If <code>&lt;barrier&gt;</code> is specified, it
2463 is the string that will be shown instead of the default one.
2464 </p>
2465 </dd>
2466 </dl></div>
2467 </div>
2468 </div>
2469 </div>
2470 <div class="sect1">
2471 <h2 id="_pretty_formats">PRETTY FORMATS</h2>
2472 <div class="sectionbody">
2473 <div class="paragraph"><p>If the commit is a merge, and if the pretty-format
2474 is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is
2475 inserted before the <em>Author:</em> line. This line begins with
2476 "Merge: " and the hashes of ancestral commits are printed,
2477 separated by spaces. Note that the listed commits may not
2478 necessarily be the list of the <strong>direct</strong> parent commits if you
2479 have limited your view of history: for example, if you are
2480 only interested in changes related to a certain directory or
2481 file.</p></div>
2482 <div class="paragraph"><p>There are several built-in formats, and you can define
2483 additional formats by setting a pretty.&lt;name&gt;
2484 config option to either another format name, or a
2485 <em>format:</em> string, as described below (see
2486 <a href="git-config.html">git-config(1)</a>). Here are the details of the
2487 built-in formats:</p></div>
2488 <div class="ulist"><ul>
2489 <li>
2491 <em>oneline</em>
2492 </p>
2493 <div class="literalblock">
2494 <div class="content">
2495 <pre><code>&lt;hash&gt; &lt;title-line&gt;</code></pre>
2496 </div></div>
2497 <div class="paragraph"><p>This is designed to be as compact as possible.</p></div>
2498 </li>
2499 <li>
2501 <em>short</em>
2502 </p>
2503 <div class="literalblock">
2504 <div class="content">
2505 <pre><code>commit &lt;hash&gt;
2506 Author: &lt;author&gt;</code></pre>
2507 </div></div>
2508 <div class="literalblock">
2509 <div class="content">
2510 <pre><code>&lt;title-line&gt;</code></pre>
2511 </div></div>
2512 </li>
2513 <li>
2515 <em>medium</em>
2516 </p>
2517 <div class="literalblock">
2518 <div class="content">
2519 <pre><code>commit &lt;hash&gt;
2520 Author: &lt;author&gt;
2521 Date: &lt;author-date&gt;</code></pre>
2522 </div></div>
2523 <div class="literalblock">
2524 <div class="content">
2525 <pre><code>&lt;title-line&gt;</code></pre>
2526 </div></div>
2527 <div class="literalblock">
2528 <div class="content">
2529 <pre><code>&lt;full-commit-message&gt;</code></pre>
2530 </div></div>
2531 </li>
2532 <li>
2534 <em>full</em>
2535 </p>
2536 <div class="literalblock">
2537 <div class="content">
2538 <pre><code>commit &lt;hash&gt;
2539 Author: &lt;author&gt;
2540 Commit: &lt;committer&gt;</code></pre>
2541 </div></div>
2542 <div class="literalblock">
2543 <div class="content">
2544 <pre><code>&lt;title-line&gt;</code></pre>
2545 </div></div>
2546 <div class="literalblock">
2547 <div class="content">
2548 <pre><code>&lt;full-commit-message&gt;</code></pre>
2549 </div></div>
2550 </li>
2551 <li>
2553 <em>fuller</em>
2554 </p>
2555 <div class="literalblock">
2556 <div class="content">
2557 <pre><code>commit &lt;hash&gt;
2558 Author: &lt;author&gt;
2559 AuthorDate: &lt;author-date&gt;
2560 Commit: &lt;committer&gt;
2561 CommitDate: &lt;committer-date&gt;</code></pre>
2562 </div></div>
2563 <div class="literalblock">
2564 <div class="content">
2565 <pre><code>&lt;title-line&gt;</code></pre>
2566 </div></div>
2567 <div class="literalblock">
2568 <div class="content">
2569 <pre><code>&lt;full-commit-message&gt;</code></pre>
2570 </div></div>
2571 </li>
2572 <li>
2574 <em>reference</em>
2575 </p>
2576 <div class="literalblock">
2577 <div class="content">
2578 <pre><code>&lt;abbrev-hash&gt; (&lt;title-line&gt;, &lt;short-author-date&gt;)</code></pre>
2579 </div></div>
2580 <div class="paragraph"><p>This format is used to refer to another commit in a commit message and
2581 is the same as <code>--pretty='format:%C(auto)%h (%s, %ad)'</code>. By default,
2582 the date is formatted with <code>--date=short</code> unless another <code>--date</code> option
2583 is explicitly specified. As with any <code>format:</code> with format
2584 placeholders, its output is not affected by other options like
2585 <code>--decorate</code> and <code>--walk-reflogs</code>.</p></div>
2586 </li>
2587 <li>
2589 <em>email</em>
2590 </p>
2591 <div class="literalblock">
2592 <div class="content">
2593 <pre><code>From &lt;hash&gt; &lt;date&gt;
2594 From: &lt;author&gt;
2595 Date: &lt;author-date&gt;
2596 Subject: [PATCH] &lt;title-line&gt;</code></pre>
2597 </div></div>
2598 <div class="literalblock">
2599 <div class="content">
2600 <pre><code>&lt;full-commit-message&gt;</code></pre>
2601 </div></div>
2602 </li>
2603 <li>
2605 <em>mboxrd</em>
2606 </p>
2607 <div class="paragraph"><p>Like <em>email</em>, but lines in the commit message starting with "From "
2608 (preceded by zero or more "&gt;") are quoted with "&gt;" so they aren&#8217;t
2609 confused as starting a new commit.</p></div>
2610 </li>
2611 <li>
2613 <em>raw</em>
2614 </p>
2615 <div class="paragraph"><p>The <em>raw</em> format shows the entire commit exactly as
2616 stored in the commit object. Notably, the hashes are
2617 displayed in full, regardless of whether --abbrev or
2618 --no-abbrev are used, and <em>parents</em> information show the
2619 true parent commits, without taking grafts or history
2620 simplification into account. Note that this format affects the way
2621 commits are displayed, but not the way the diff is shown e.g. with
2622 <code>git log --raw</code>. To get full object names in a raw diff format,
2623 use <code>--no-abbrev</code>.</p></div>
2624 </li>
2625 <li>
2627 <em>format:&lt;format-string&gt;</em>
2628 </p>
2629 <div class="paragraph"><p>The <em>format:&lt;format-string&gt;</em> format allows you to specify which information
2630 you want to show. It works a little bit like printf format,
2631 with the notable exception that you get a newline with <em>%n</em>
2632 instead of <em>\n</em>.</p></div>
2633 <div class="paragraph"><p>E.g, <em>format:"The author of %h was %an, %ar%nThe title was &gt;&gt;%s&lt;&lt;%n"</em>
2634 would show something like this:</p></div>
2635 <div class="listingblock">
2636 <div class="content">
2637 <pre><code>The author of fe6e0ee was Junio C Hamano, 23 hours ago
2638 The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;</code></pre>
2639 </div></div>
2640 <div class="paragraph"><p>The placeholders are:</p></div>
2641 <div class="ulist"><ul>
2642 <li>
2644 Placeholders that expand to a single literal character:
2645 </p>
2646 <div class="dlist"><dl>
2647 <dt class="hdlist1">
2648 <em>%n</em>
2649 </dt>
2650 <dd>
2652 newline
2653 </p>
2654 </dd>
2655 <dt class="hdlist1">
2656 <em>%%</em>
2657 </dt>
2658 <dd>
2660 a raw <em>%</em>
2661 </p>
2662 </dd>
2663 <dt class="hdlist1">
2664 <em>%x00</em>
2665 </dt>
2666 <dd>
2668 <em>%x</em> followed by two hexadecimal digits is replaced with a
2669 byte with the hexadecimal digits' value (we will call this
2670 "literal formatting code" in the rest of this document).
2671 </p>
2672 </dd>
2673 </dl></div>
2674 </li>
2675 <li>
2677 Placeholders that affect formatting of later placeholders:
2678 </p>
2679 <div class="dlist"><dl>
2680 <dt class="hdlist1">
2681 <em>%Cred</em>
2682 </dt>
2683 <dd>
2685 switch color to red
2686 </p>
2687 </dd>
2688 <dt class="hdlist1">
2689 <em>%Cgreen</em>
2690 </dt>
2691 <dd>
2693 switch color to green
2694 </p>
2695 </dd>
2696 <dt class="hdlist1">
2697 <em>%Cblue</em>
2698 </dt>
2699 <dd>
2701 switch color to blue
2702 </p>
2703 </dd>
2704 <dt class="hdlist1">
2705 <em>%Creset</em>
2706 </dt>
2707 <dd>
2709 reset color
2710 </p>
2711 </dd>
2712 <dt class="hdlist1">
2713 <em>%C(&#8230;)</em>
2714 </dt>
2715 <dd>
2717 color specification, as described under Values in the
2718 "CONFIGURATION FILE" section of <a href="git-config.html">git-config(1)</a>. By
2719 default, colors are shown only when enabled for log output
2720 (by <code>color.diff</code>, <code>color.ui</code>, or <code>--color</code>, and respecting
2721 the <code>auto</code> settings of the former if we are going to a
2722 terminal). <code>%C(auto,...)</code> is accepted as a historical
2723 synonym for the default (e.g., <code>%C(auto,red)</code>). Specifying
2724 <code>%C(always,...)</code> will show the colors even when color is
2725 not otherwise enabled (though consider just using
2726 <code>--color=always</code> to enable color for the whole output,
2727 including this format and anything else git might color).
2728 <code>auto</code> alone (i.e. <code>%C(auto)</code>) will turn on auto coloring
2729 on the next placeholders until the color is switched
2730 again.
2731 </p>
2732 </dd>
2733 <dt class="hdlist1">
2734 <em>%m</em>
2735 </dt>
2736 <dd>
2738 left (<code>&lt;</code>), right (<code>&gt;</code>) or boundary (<code>-</code>) mark
2739 </p>
2740 </dd>
2741 <dt class="hdlist1">
2742 <em>%w([&lt;w&gt;[,&lt;i1&gt;[,&lt;i2&gt;]]])</em>
2743 </dt>
2744 <dd>
2746 switch line wrapping, like the -w option of
2747 <a href="git-shortlog.html">git-shortlog(1)</a>.
2748 </p>
2749 </dd>
2750 <dt class="hdlist1">
2751 <em>%&lt;( &lt;N&gt; [,trunc|ltrunc|mtrunc])</em>
2752 </dt>
2753 <dd>
2755 make the next placeholder take at
2756 least N column widths, padding spaces on
2757 the right if necessary. Optionally
2758 truncate (with ellipsis <em>..</em>) at the left (ltrunc) <code>..ft</code>,
2759 the middle (mtrunc) <code>mi..le</code>, or the end
2760 (trunc) <code>rig..</code>, if the output is longer than
2761 N columns.
2762 Note 1: that truncating
2763 only works correctly with N &gt;= 2.
2764 Note 2: spaces around the N and M (see below)
2765 values are optional.
2766 Note 3: Emojis and other wide characters
2767 will take two display columns, which may
2768 over-run column boundaries.
2769 Note 4: decomposed character combining marks
2770 may be misplaced at padding boundaries.
2771 </p>
2772 </dd>
2773 <dt class="hdlist1">
2774 <em>%&lt;|( &lt;M&gt; )</em>
2775 </dt>
2776 <dd>
2778 make the next placeholder take at least until Mth
2779 display column, padding spaces on the right if necessary.
2780 Use negative M values for column positions measured
2781 from the right hand edge of the terminal window.
2782 </p>
2783 </dd>
2784 <dt class="hdlist1">
2785 <em>%&gt;( &lt;N&gt; )</em>, <em>%&gt;|( &lt;M&gt; )</em>
2786 </dt>
2787 <dd>
2789 similar to <em>%&lt;( &lt;N&gt; )</em>, <em>%&lt;|( &lt;M&gt; )</em> respectively,
2790 but padding spaces on the left
2791 </p>
2792 </dd>
2793 <dt class="hdlist1">
2794 <em>%&gt;&gt;( &lt;N&gt; )</em>, <em>%&gt;&gt;|( &lt;M&gt; )</em>
2795 </dt>
2796 <dd>
2798 similar to <em>%&gt;( &lt;N&gt; )</em>, <em>%&gt;|( &lt;M&gt; )</em>
2799 respectively, except that if the next
2800 placeholder takes more spaces than given and
2801 there are spaces on its left, use those
2802 spaces
2803 </p>
2804 </dd>
2805 <dt class="hdlist1">
2806 <em>%&gt;&lt;( &lt;N&gt; )</em>, <em>%&gt;&lt;|( &lt;M&gt; )</em>
2807 </dt>
2808 <dd>
2810 similar to <em>%&lt;( &lt;N&gt; )</em>, <em>%&lt;|( &lt;M&gt; )</em>
2811 respectively, but padding both sides
2812 (i.e. the text is centered)
2813 </p>
2814 </dd>
2815 </dl></div>
2816 </li>
2817 <li>
2819 Placeholders that expand to information extracted from the commit:
2820 </p>
2821 <div class="dlist"><dl>
2822 <dt class="hdlist1">
2823 <em>%H</em>
2824 </dt>
2825 <dd>
2827 commit hash
2828 </p>
2829 </dd>
2830 <dt class="hdlist1">
2831 <em>%h</em>
2832 </dt>
2833 <dd>
2835 abbreviated commit hash
2836 </p>
2837 </dd>
2838 <dt class="hdlist1">
2839 <em>%T</em>
2840 </dt>
2841 <dd>
2843 tree hash
2844 </p>
2845 </dd>
2846 <dt class="hdlist1">
2847 <em>%t</em>
2848 </dt>
2849 <dd>
2851 abbreviated tree hash
2852 </p>
2853 </dd>
2854 <dt class="hdlist1">
2855 <em>%P</em>
2856 </dt>
2857 <dd>
2859 parent hashes
2860 </p>
2861 </dd>
2862 <dt class="hdlist1">
2863 <em>%p</em>
2864 </dt>
2865 <dd>
2867 abbreviated parent hashes
2868 </p>
2869 </dd>
2870 <dt class="hdlist1">
2871 <em>%an</em>
2872 </dt>
2873 <dd>
2875 author name
2876 </p>
2877 </dd>
2878 <dt class="hdlist1">
2879 <em>%aN</em>
2880 </dt>
2881 <dd>
2883 author name (respecting .mailmap, see <a href="git-shortlog.html">git-shortlog(1)</a>
2884 or <a href="git-blame.html">git-blame(1)</a>)
2885 </p>
2886 </dd>
2887 <dt class="hdlist1">
2888 <em>%ae</em>
2889 </dt>
2890 <dd>
2892 author email
2893 </p>
2894 </dd>
2895 <dt class="hdlist1">
2896 <em>%aE</em>
2897 </dt>
2898 <dd>
2900 author email (respecting .mailmap, see <a href="git-shortlog.html">git-shortlog(1)</a>
2901 or <a href="git-blame.html">git-blame(1)</a>)
2902 </p>
2903 </dd>
2904 <dt class="hdlist1">
2905 <em>%al</em>
2906 </dt>
2907 <dd>
2909 author email local-part (the part before the <em>@</em> sign)
2910 </p>
2911 </dd>
2912 <dt class="hdlist1">
2913 <em>%aL</em>
2914 </dt>
2915 <dd>
2917 author local-part (see <em>%al</em>) respecting .mailmap, see
2918 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
2919 </p>
2920 </dd>
2921 <dt class="hdlist1">
2922 <em>%ad</em>
2923 </dt>
2924 <dd>
2926 author date (format respects --date= option)
2927 </p>
2928 </dd>
2929 <dt class="hdlist1">
2930 <em>%aD</em>
2931 </dt>
2932 <dd>
2934 author date, RFC2822 style
2935 </p>
2936 </dd>
2937 <dt class="hdlist1">
2938 <em>%ar</em>
2939 </dt>
2940 <dd>
2942 author date, relative
2943 </p>
2944 </dd>
2945 <dt class="hdlist1">
2946 <em>%at</em>
2947 </dt>
2948 <dd>
2950 author date, UNIX timestamp
2951 </p>
2952 </dd>
2953 <dt class="hdlist1">
2954 <em>%ai</em>
2955 </dt>
2956 <dd>
2958 author date, ISO 8601-like format
2959 </p>
2960 </dd>
2961 <dt class="hdlist1">
2962 <em>%aI</em>
2963 </dt>
2964 <dd>
2966 author date, strict ISO 8601 format
2967 </p>
2968 </dd>
2969 <dt class="hdlist1">
2970 <em>%as</em>
2971 </dt>
2972 <dd>
2974 author date, short format (<code>YYYY-MM-DD</code>)
2975 </p>
2976 </dd>
2977 <dt class="hdlist1">
2978 <em>%ah</em>
2979 </dt>
2980 <dd>
2982 author date, human style (like the <code>--date=human</code> option of
2983 <a href="git-rev-list.html">git-rev-list(1)</a>)
2984 </p>
2985 </dd>
2986 <dt class="hdlist1">
2987 <em>%cn</em>
2988 </dt>
2989 <dd>
2991 committer name
2992 </p>
2993 </dd>
2994 <dt class="hdlist1">
2995 <em>%cN</em>
2996 </dt>
2997 <dd>
2999 committer name (respecting .mailmap, see
3000 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3001 </p>
3002 </dd>
3003 <dt class="hdlist1">
3004 <em>%ce</em>
3005 </dt>
3006 <dd>
3008 committer email
3009 </p>
3010 </dd>
3011 <dt class="hdlist1">
3012 <em>%cE</em>
3013 </dt>
3014 <dd>
3016 committer email (respecting .mailmap, see
3017 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3018 </p>
3019 </dd>
3020 <dt class="hdlist1">
3021 <em>%cl</em>
3022 </dt>
3023 <dd>
3025 committer email local-part (the part before the <em>@</em> sign)
3026 </p>
3027 </dd>
3028 <dt class="hdlist1">
3029 <em>%cL</em>
3030 </dt>
3031 <dd>
3033 committer local-part (see <em>%cl</em>) respecting .mailmap, see
3034 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3035 </p>
3036 </dd>
3037 <dt class="hdlist1">
3038 <em>%cd</em>
3039 </dt>
3040 <dd>
3042 committer date (format respects --date= option)
3043 </p>
3044 </dd>
3045 <dt class="hdlist1">
3046 <em>%cD</em>
3047 </dt>
3048 <dd>
3050 committer date, RFC2822 style
3051 </p>
3052 </dd>
3053 <dt class="hdlist1">
3054 <em>%cr</em>
3055 </dt>
3056 <dd>
3058 committer date, relative
3059 </p>
3060 </dd>
3061 <dt class="hdlist1">
3062 <em>%ct</em>
3063 </dt>
3064 <dd>
3066 committer date, UNIX timestamp
3067 </p>
3068 </dd>
3069 <dt class="hdlist1">
3070 <em>%ci</em>
3071 </dt>
3072 <dd>
3074 committer date, ISO 8601-like format
3075 </p>
3076 </dd>
3077 <dt class="hdlist1">
3078 <em>%cI</em>
3079 </dt>
3080 <dd>
3082 committer date, strict ISO 8601 format
3083 </p>
3084 </dd>
3085 <dt class="hdlist1">
3086 <em>%cs</em>
3087 </dt>
3088 <dd>
3090 committer date, short format (<code>YYYY-MM-DD</code>)
3091 </p>
3092 </dd>
3093 <dt class="hdlist1">
3094 <em>%ch</em>
3095 </dt>
3096 <dd>
3098 committer date, human style (like the <code>--date=human</code> option of
3099 <a href="git-rev-list.html">git-rev-list(1)</a>)
3100 </p>
3101 </dd>
3102 <dt class="hdlist1">
3103 <em>%d</em>
3104 </dt>
3105 <dd>
3107 ref names, like the --decorate option of <a href="git-log.html">git-log(1)</a>
3108 </p>
3109 </dd>
3110 <dt class="hdlist1">
3111 <em>%D</em>
3112 </dt>
3113 <dd>
3115 ref names without the " (", ")" wrapping.
3116 </p>
3117 </dd>
3118 <dt class="hdlist1">
3119 <em>%(decorate[:&lt;options&gt;])</em>
3120 </dt>
3121 <dd>
3123 ref names with custom decorations. The <code>decorate</code> string may be followed by a
3124 colon and zero or more comma-separated options. Option values may contain
3125 literal formatting codes. These must be used for commas (<code>%x2C</code>) and closing
3126 parentheses (<code>%x29</code>), due to their role in the option syntax.
3127 </p>
3128 <div class="ulist"><ul>
3129 <li>
3131 <em>prefix=&lt;value&gt;</em>: Shown before the list of ref names. Defaults to "&#160;<code>(</code>".
3132 </p>
3133 </li>
3134 <li>
3136 <em>suffix=&lt;value&gt;</em>: Shown after the list of ref names. Defaults to "<code>)</code>".
3137 </p>
3138 </li>
3139 <li>
3141 <em>separator=&lt;value&gt;</em>: Shown between ref names. Defaults to "<code>,</code>&#160;".
3142 </p>
3143 </li>
3144 <li>
3146 <em>pointer=&lt;value&gt;</em>: Shown between HEAD and the branch it points to, if any.
3147 Defaults to "&#160;<code>-&gt;</code>&#160;".
3148 </p>
3149 </li>
3150 <li>
3152 <em>tag=&lt;value&gt;</em>: Shown before tag names. Defaults to "<code>tag:</code>&#160;".
3153 </p>
3154 </li>
3155 </ul></div>
3156 <div class="paragraph"><p>For example, to produce decorations with no wrapping
3157 or tag annotations, and spaces as separators:</p></div>
3158 <div class="paragraph"><p><code>%(decorate:prefix=,suffix=,tag=,separator= )</code></p></div>
3159 </dd>
3160 <dt class="hdlist1">
3161 <em>%(describe[:&lt;options&gt;])</em>
3162 </dt>
3163 <dd>
3165 human-readable name, like <a href="git-describe.html">git-describe(1)</a>; empty string for
3166 undescribable commits. The <code>describe</code> string may be followed by a colon and
3167 zero or more comma-separated options. Descriptions can be inconsistent when
3168 tags are added or removed at the same time.
3169 </p>
3170 <div class="ulist"><ul>
3171 <li>
3173 <em>tags[=&lt;bool-value&gt;]</em>: Instead of only considering annotated tags,
3174 consider lightweight tags as well.
3175 </p>
3176 </li>
3177 <li>
3179 <em>abbrev=&lt;number&gt;</em>: Instead of using the default number of hexadecimal digits
3180 (which will vary according to the number of objects in the repository with a
3181 default of 7) of the abbreviated object name, use &lt;number&gt; digits, or as many
3182 digits as needed to form a unique object name.
3183 </p>
3184 </li>
3185 <li>
3187 <em>match=&lt;pattern&gt;</em>: Only consider tags matching the given
3188 <code>glob(7)</code> pattern, excluding the "refs/tags/" prefix.
3189 </p>
3190 </li>
3191 <li>
3193 <em>exclude=&lt;pattern&gt;</em>: Do not consider tags matching the given
3194 <code>glob(7)</code> pattern, excluding the "refs/tags/" prefix.
3195 </p>
3196 </li>
3197 </ul></div>
3198 </dd>
3199 <dt class="hdlist1">
3200 <em>%S</em>
3201 </dt>
3202 <dd>
3204 ref name given on the command line by which the commit was reached
3205 (like <code>git log --source</code>), only works with <code>git log</code>
3206 </p>
3207 </dd>
3208 <dt class="hdlist1">
3209 <em>%e</em>
3210 </dt>
3211 <dd>
3213 encoding
3214 </p>
3215 </dd>
3216 <dt class="hdlist1">
3217 <em>%s</em>
3218 </dt>
3219 <dd>
3221 subject
3222 </p>
3223 </dd>
3224 <dt class="hdlist1">
3225 <em>%f</em>
3226 </dt>
3227 <dd>
3229 sanitized subject line, suitable for a filename
3230 </p>
3231 </dd>
3232 <dt class="hdlist1">
3233 <em>%b</em>
3234 </dt>
3235 <dd>
3237 body
3238 </p>
3239 </dd>
3240 <dt class="hdlist1">
3241 <em>%B</em>
3242 </dt>
3243 <dd>
3245 raw body (unwrapped subject and body)
3246 </p>
3247 </dd>
3248 <dt class="hdlist1">
3249 <em>%N</em>
3250 </dt>
3251 <dd>
3253 commit notes
3254 </p>
3255 </dd>
3256 <dt class="hdlist1">
3257 <em>%GG</em>
3258 </dt>
3259 <dd>
3261 raw verification message from GPG for a signed commit
3262 </p>
3263 </dd>
3264 <dt class="hdlist1">
3265 <em>%G?</em>
3266 </dt>
3267 <dd>
3269 show "G" for a good (valid) signature,
3270 "B" for a bad signature,
3271 "U" for a good signature with unknown validity,
3272 "X" for a good signature that has expired,
3273 "Y" for a good signature made by an expired key,
3274 "R" for a good signature made by a revoked key,
3275 "E" if the signature cannot be checked (e.g. missing key)
3276 and "N" for no signature
3277 </p>
3278 </dd>
3279 <dt class="hdlist1">
3280 <em>%GS</em>
3281 </dt>
3282 <dd>
3284 show the name of the signer for a signed commit
3285 </p>
3286 </dd>
3287 <dt class="hdlist1">
3288 <em>%GK</em>
3289 </dt>
3290 <dd>
3292 show the key used to sign a signed commit
3293 </p>
3294 </dd>
3295 <dt class="hdlist1">
3296 <em>%GF</em>
3297 </dt>
3298 <dd>
3300 show the fingerprint of the key used to sign a signed commit
3301 </p>
3302 </dd>
3303 <dt class="hdlist1">
3304 <em>%GP</em>
3305 </dt>
3306 <dd>
3308 show the fingerprint of the primary key whose subkey was used
3309 to sign a signed commit
3310 </p>
3311 </dd>
3312 <dt class="hdlist1">
3313 <em>%GT</em>
3314 </dt>
3315 <dd>
3317 show the trust level for the key used to sign a signed commit
3318 </p>
3319 </dd>
3320 <dt class="hdlist1">
3321 <em>%gD</em>
3322 </dt>
3323 <dd>
3325 reflog selector, e.g., <code>refs/stash@{1}</code> or <code>refs/stash@{2
3326 minutes ago}</code>; the format follows the rules described for the
3327 <code>-g</code> option. The portion before the <code>@</code> is the refname as
3328 given on the command line (so <code>git log -g refs/heads/master</code>
3329 would yield <code>refs/heads/master@{0}</code>).
3330 </p>
3331 </dd>
3332 <dt class="hdlist1">
3333 <em>%gd</em>
3334 </dt>
3335 <dd>
3337 shortened reflog selector; same as <code>%gD</code>, but the refname
3338 portion is shortened for human readability (so
3339 <code>refs/heads/master</code> becomes just <code>master</code>).
3340 </p>
3341 </dd>
3342 <dt class="hdlist1">
3343 <em>%gn</em>
3344 </dt>
3345 <dd>
3347 reflog identity name
3348 </p>
3349 </dd>
3350 <dt class="hdlist1">
3351 <em>%gN</em>
3352 </dt>
3353 <dd>
3355 reflog identity name (respecting .mailmap, see
3356 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3357 </p>
3358 </dd>
3359 <dt class="hdlist1">
3360 <em>%ge</em>
3361 </dt>
3362 <dd>
3364 reflog identity email
3365 </p>
3366 </dd>
3367 <dt class="hdlist1">
3368 <em>%gE</em>
3369 </dt>
3370 <dd>
3372 reflog identity email (respecting .mailmap, see
3373 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3374 </p>
3375 </dd>
3376 <dt class="hdlist1">
3377 <em>%gs</em>
3378 </dt>
3379 <dd>
3381 reflog subject
3382 </p>
3383 </dd>
3384 <dt class="hdlist1">
3385 <em>%(trailers[:&lt;options&gt;])</em>
3386 </dt>
3387 <dd>
3389 display the trailers of the body as interpreted by
3390 <a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>. The <code>trailers</code> string may be followed by
3391 a colon and zero or more comma-separated options. If any option is provided
3392 multiple times, the last occurrence wins.
3393 </p>
3394 <div class="ulist"><ul>
3395 <li>
3397 <em>key=&lt;key&gt;</em>: only show trailers with specified &lt;key&gt;. Matching is done
3398 case-insensitively and trailing colon is optional. If option is
3399 given multiple times trailer lines matching any of the keys are
3400 shown. This option automatically enables the <code>only</code> option so that
3401 non-trailer lines in the trailer block are hidden. If that is not
3402 desired it can be disabled with <code>only=false</code>. E.g.,
3403 <code>%(trailers:key=Reviewed-by)</code> shows trailer lines with key
3404 <code>Reviewed-by</code>.
3405 </p>
3406 </li>
3407 <li>
3409 <em>only[=&lt;bool&gt;]</em>: select whether non-trailer lines from the trailer
3410 block should be included.
3411 </p>
3412 </li>
3413 <li>
3415 <em>separator=&lt;sep&gt;</em>: specify a separator inserted between trailer
3416 lines. When this option is not given each trailer line is
3417 terminated with a line feed character. The string &lt;sep&gt; may contain
3418 the literal formatting codes described above. To use comma as
3419 separator one must use <code>%x2C</code> as it would otherwise be parsed as
3420 next option. E.g., <code>%(trailers:key=Ticket,separator=%x2C )</code>
3421 shows all trailer lines whose key is "Ticket" separated by a comma
3422 and a space.
3423 </p>
3424 </li>
3425 <li>
3427 <em>unfold[=&lt;bool&gt;]</em>: make it behave as if interpret-trailer&#8217;s <code>--unfold</code>
3428 option was given. E.g.,
3429 <code>%(trailers:only,unfold=true)</code> unfolds and shows all trailer lines.
3430 </p>
3431 </li>
3432 <li>
3434 <em>keyonly[=&lt;bool&gt;]</em>: only show the key part of the trailer.
3435 </p>
3436 </li>
3437 <li>
3439 <em>valueonly[=&lt;bool&gt;]</em>: only show the value part of the trailer.
3440 </p>
3441 </li>
3442 <li>
3444 <em>key_value_separator=&lt;sep&gt;</em>: specify a separator inserted between
3445 trailer lines. When this option is not given each trailer key-value
3446 pair is separated by ": ". Otherwise it shares the same semantics
3447 as <em>separator=&lt;sep&gt;</em> above.
3448 </p>
3449 </li>
3450 </ul></div>
3451 </dd>
3452 </dl></div>
3453 </li>
3454 </ul></div>
3455 </li>
3456 </ul></div>
3457 <div class="admonitionblock">
3458 <table><tr>
3459 <td class="icon">
3460 <div class="title">Note</div>
3461 </td>
3462 <td class="content">Some placeholders may depend on other options given to the
3463 revision traversal engine. For example, the <code>%g*</code> reflog options will
3464 insert an empty string unless we are traversing reflog entries (e.g., by
3465 <code>git log -g</code>). The <code>%d</code> and <code>%D</code> placeholders will use the "short"
3466 decoration format if <code>--decorate</code> was not already provided on the command
3467 line.</td>
3468 </tr></table>
3469 </div>
3470 <div class="paragraph"><p>The boolean options accept an optional value <code>[=&lt;bool-value&gt;]</code>. The values
3471 <code>true</code>, <code>false</code>, <code>on</code>, <code>off</code> etc. are all accepted. See the "boolean"
3472 sub-section in "EXAMPLES" in <a href="git-config.html">git-config(1)</a>. If a boolean
3473 option is given with no value, it&#8217;s enabled.</p></div>
3474 <div class="paragraph"><p>If you add a <code>+</code> (plus sign) after <em>%</em> of a placeholder, a line-feed
3475 is inserted immediately before the expansion if and only if the
3476 placeholder expands to a non-empty string.</p></div>
3477 <div class="paragraph"><p>If you add a <code>-</code> (minus sign) after <em>%</em> of a placeholder, all consecutive
3478 line-feeds immediately preceding the expansion are deleted if and only if the
3479 placeholder expands to an empty string.</p></div>
3480 <div class="paragraph"><p>If you add a ` ` (space) after <em>%</em> of a placeholder, a space
3481 is inserted immediately before the expansion if and only if the
3482 placeholder expands to a non-empty string.</p></div>
3483 <div class="ulist"><ul>
3484 <li>
3486 <em>tformat:</em>
3487 </p>
3488 <div class="paragraph"><p>The <em>tformat:</em> format works exactly like <em>format:</em>, except that it
3489 provides "terminator" semantics instead of "separator" semantics. In
3490 other words, each commit has the message terminator character (usually a
3491 newline) appended, rather than a separator placed between entries.
3492 This means that the final entry of a single-line format will be properly
3493 terminated with a new line, just as the "oneline" format does.
3494 For example:</p></div>
3495 <div class="listingblock">
3496 <div class="content">
3497 <pre><code>$ git log -2 --pretty=format:%h 4da45bef \
3498 | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
3499 4da45be
3500 7134973 -- NO NEWLINE
3502 $ git log -2 --pretty=tformat:%h 4da45bef \
3503 | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
3504 4da45be
3505 7134973</code></pre>
3506 </div></div>
3507 <div class="paragraph"><p>In addition, any unrecognized string that has a <code>%</code> in it is interpreted
3508 as if it has <code>tformat:</code> in front of it. For example, these two are
3509 equivalent:</p></div>
3510 <div class="listingblock">
3511 <div class="content">
3512 <pre><code>$ git log -2 --pretty=tformat:%h 4da45bef
3513 $ git log -2 --pretty=%h 4da45bef</code></pre>
3514 </div></div>
3515 </li>
3516 </ul></div>
3517 </div>
3518 </div>
3519 <div class="sect1">
3520 <h2 id="_diff_formatting">DIFF FORMATTING</h2>
3521 <div class="sectionbody">
3522 <div class="paragraph"><p>By default, <code>git log</code> does not generate any diff output. The options
3523 below can be used to show the changes made by each commit.</p></div>
3524 <div class="paragraph"><p>Note that unless one of <code>--diff-merges</code> variants (including short
3525 <code>-m</code>, <code>-c</code>, and <code>--cc</code> options) is explicitly given, merge commits
3526 will not show a diff, even if a diff format like <code>--patch</code> is
3527 selected, nor will they match search options like <code>-S</code>. The exception
3528 is when <code>--first-parent</code> is in use, in which case <code>first-parent</code> is
3529 the default format.</p></div>
3530 <div class="dlist"><dl>
3531 <dt class="hdlist1">
3533 </dt>
3534 <dt class="hdlist1">
3536 </dt>
3537 <dt class="hdlist1">
3538 --patch
3539 </dt>
3540 <dd>
3542 Generate patch (see <a href="#generate_patch_text_with_p">[generate_patch_text_with_p]</a>).
3543 </p>
3544 </dd>
3545 <dt class="hdlist1">
3547 </dt>
3548 <dt class="hdlist1">
3549 --no-patch
3550 </dt>
3551 <dd>
3553 Suppress all output from the diff machinery. Useful for
3554 commands like <code>git show</code> that show the patch by default to
3555 squelch their output, or to cancel the effect of options like
3556 <code>--patch</code>, <code>--stat</code> earlier on the command line in an alias.
3557 </p>
3558 </dd>
3559 <dt class="hdlist1">
3560 --diff-merges=(off|none|on|first-parent|1|separate|m|combined|c|dense-combined|cc|remerge|r)
3561 </dt>
3562 <dt class="hdlist1">
3563 --no-diff-merges
3564 </dt>
3565 <dd>
3567 Specify diff format to be used for merge commits. Default is
3568 <code>off</code> unless <code>--first-parent</code> is in use, in which case
3569 <code>first-parent</code> is the default.
3570 </p>
3571 <div class="dlist"><dl>
3572 <dt class="hdlist1">
3573 --diff-merges=(off|none)
3574 </dt>
3575 <dt class="hdlist1">
3576 --no-diff-merges
3577 </dt>
3578 <dd>
3580 Disable output of diffs for merge commits. Useful to override
3581 implied value.
3582 </p>
3583 </dd>
3584 <dt class="hdlist1">
3585 --diff-merges=on
3586 </dt>
3587 <dt class="hdlist1">
3588 --diff-merges=m
3589 </dt>
3590 <dt class="hdlist1">
3592 </dt>
3593 <dd>
3595 This option makes diff output for merge commits to be shown in
3596 the default format. <code>-m</code> will produce the output only if <code>-p</code>
3597 is given as well. The default format could be changed using
3598 <code>log.diffMerges</code> configuration parameter, which default value
3599 is <code>separate</code>.
3600 </p>
3601 </dd>
3602 <dt class="hdlist1">
3603 --diff-merges=first-parent
3604 </dt>
3605 <dt class="hdlist1">
3606 --diff-merges=1
3607 </dt>
3608 <dd>
3610 This option makes merge commits show the full diff with
3611 respect to the first parent only.
3612 </p>
3613 </dd>
3614 <dt class="hdlist1">
3615 --diff-merges=separate
3616 </dt>
3617 <dd>
3619 This makes merge commits show the full diff with respect to
3620 each of the parents. Separate log entry and diff is generated
3621 for each parent.
3622 </p>
3623 </dd>
3624 <dt class="hdlist1">
3625 --diff-merges=remerge
3626 </dt>
3627 <dt class="hdlist1">
3628 --diff-merges=r
3629 </dt>
3630 <dt class="hdlist1">
3631 --remerge-diff
3632 </dt>
3633 <dd>
3635 With this option, two-parent merge commits are remerged to
3636 create a temporary tree object&#8201;&#8212;&#8201;potentially containing files
3637 with conflict markers and such. A diff is then shown between
3638 that temporary tree and the actual merge commit.
3639 </p>
3640 <div class="paragraph"><p>The output emitted when this option is used is subject to change, and
3641 so is its interaction with other options (unless explicitly
3642 documented).</p></div>
3643 </dd>
3644 <dt class="hdlist1">
3645 --diff-merges=combined
3646 </dt>
3647 <dt class="hdlist1">
3648 --diff-merges=c
3649 </dt>
3650 <dt class="hdlist1">
3652 </dt>
3653 <dd>
3655 With this option, diff output for a merge commit shows the
3656 differences from each of the parents to the merge result
3657 simultaneously instead of showing pairwise diff between a
3658 parent and the result one at a time. Furthermore, it lists
3659 only files which were modified from all parents. <code>-c</code> implies
3660 <code>-p</code>.
3661 </p>
3662 </dd>
3663 <dt class="hdlist1">
3664 --diff-merges=dense-combined
3665 </dt>
3666 <dt class="hdlist1">
3667 --diff-merges=cc
3668 </dt>
3669 <dt class="hdlist1">
3670 --cc
3671 </dt>
3672 <dd>
3674 With this option the output produced by
3675 <code>--diff-merges=combined</code> is further compressed by omitting
3676 uninteresting hunks whose contents in the parents have only
3677 two variants and the merge result picks one of them without
3678 modification. <code>--cc</code> implies <code>-p</code>.
3679 </p>
3680 </dd>
3681 </dl></div>
3682 </dd>
3683 <dt class="hdlist1">
3684 --combined-all-paths
3685 </dt>
3686 <dd>
3688 This flag causes combined diffs (used for merge commits) to
3689 list the name of the file from all parents. It thus only has
3690 effect when <code>--diff-merges=[dense-]combined</code> is in use, and
3691 is likely only useful if filename changes are detected (i.e.
3692 when either rename or copy detection have been requested).
3693 </p>
3694 </dd>
3695 <dt class="hdlist1">
3696 -U&lt;n&gt;
3697 </dt>
3698 <dt class="hdlist1">
3699 --unified=&lt;n&gt;
3700 </dt>
3701 <dd>
3703 Generate diffs with &lt;n&gt; lines of context instead of
3704 the usual three.
3705 Implies <code>--patch</code>.
3706 </p>
3707 </dd>
3708 <dt class="hdlist1">
3709 --output=&lt;file&gt;
3710 </dt>
3711 <dd>
3713 Output to a specific file instead of stdout.
3714 </p>
3715 </dd>
3716 <dt class="hdlist1">
3717 --output-indicator-new=&lt;char&gt;
3718 </dt>
3719 <dt class="hdlist1">
3720 --output-indicator-old=&lt;char&gt;
3721 </dt>
3722 <dt class="hdlist1">
3723 --output-indicator-context=&lt;char&gt;
3724 </dt>
3725 <dd>
3727 Specify the character used to indicate new, old or context
3728 lines in the generated patch. Normally they are <em>+</em>, <em>-</em> and
3729 ' ' respectively.
3730 </p>
3731 </dd>
3732 <dt class="hdlist1">
3733 --raw
3734 </dt>
3735 <dd>
3737 For each commit, show a summary of changes using the raw diff
3738 format. See the "RAW OUTPUT FORMAT" section of
3739 <a href="git-diff.html">git-diff(1)</a>. This is different from showing the log
3740 itself in raw format, which you can achieve with
3741 <code>--format=raw</code>.
3742 </p>
3743 </dd>
3744 <dt class="hdlist1">
3745 --patch-with-raw
3746 </dt>
3747 <dd>
3749 Synonym for <code>-p --raw</code>.
3750 </p>
3751 </dd>
3752 <dt class="hdlist1">
3754 </dt>
3755 <dd>
3757 Show the tree objects in the diff output.
3758 </p>
3759 </dd>
3760 <dt class="hdlist1">
3761 --indent-heuristic
3762 </dt>
3763 <dd>
3765 Enable the heuristic that shifts diff hunk boundaries to make patches
3766 easier to read. This is the default.
3767 </p>
3768 </dd>
3769 <dt class="hdlist1">
3770 --no-indent-heuristic
3771 </dt>
3772 <dd>
3774 Disable the indent heuristic.
3775 </p>
3776 </dd>
3777 <dt class="hdlist1">
3778 --minimal
3779 </dt>
3780 <dd>
3782 Spend extra time to make sure the smallest possible
3783 diff is produced.
3784 </p>
3785 </dd>
3786 <dt class="hdlist1">
3787 --patience
3788 </dt>
3789 <dd>
3791 Generate a diff using the "patience diff" algorithm.
3792 </p>
3793 </dd>
3794 <dt class="hdlist1">
3795 --histogram
3796 </dt>
3797 <dd>
3799 Generate a diff using the "histogram diff" algorithm.
3800 </p>
3801 </dd>
3802 <dt class="hdlist1">
3803 --anchored=&lt;text&gt;
3804 </dt>
3805 <dd>
3807 Generate a diff using the "anchored diff" algorithm.
3808 </p>
3809 <div class="paragraph"><p>This option may be specified more than once.</p></div>
3810 <div class="paragraph"><p>If a line exists in both the source and destination, exists only once,
3811 and starts with this text, this algorithm attempts to prevent it from
3812 appearing as a deletion or addition in the output. It uses the "patience
3813 diff" algorithm internally.</p></div>
3814 </dd>
3815 <dt class="hdlist1">
3816 --diff-algorithm={patience|minimal|histogram|myers}
3817 </dt>
3818 <dd>
3820 Choose a diff algorithm. The variants are as follows:
3821 </p>
3822 <div class="openblock">
3823 <div class="content">
3824 <div class="dlist"><dl>
3825 <dt class="hdlist1">
3826 <code>default</code>, <code>myers</code>
3827 </dt>
3828 <dd>
3830 The basic greedy diff algorithm. Currently, this is the default.
3831 </p>
3832 </dd>
3833 <dt class="hdlist1">
3834 <code>minimal</code>
3835 </dt>
3836 <dd>
3838 Spend extra time to make sure the smallest possible diff is
3839 produced.
3840 </p>
3841 </dd>
3842 <dt class="hdlist1">
3843 <code>patience</code>
3844 </dt>
3845 <dd>
3847 Use "patience diff" algorithm when generating patches.
3848 </p>
3849 </dd>
3850 <dt class="hdlist1">
3851 <code>histogram</code>
3852 </dt>
3853 <dd>
3855 This algorithm extends the patience algorithm to "support
3856 low-occurrence common elements".
3857 </p>
3858 </dd>
3859 </dl></div>
3860 </div></div>
3861 <div class="paragraph"><p>For instance, if you configured the <code>diff.algorithm</code> variable to a
3862 non-default value and want to use the default one, then you
3863 have to use <code>--diff-algorithm=default</code> option.</p></div>
3864 </dd>
3865 <dt class="hdlist1">
3866 --stat[=&lt;width&gt;[,&lt;name-width&gt;[,&lt;count&gt;]]]
3867 </dt>
3868 <dd>
3870 Generate a diffstat. By default, as much space as necessary
3871 will be used for the filename part, and the rest for the graph
3872 part. Maximum width defaults to terminal width, or 80 columns
3873 if not connected to a terminal, and can be overridden by
3874 <code>&lt;width&gt;</code>. The width of the filename part can be limited by
3875 giving another width <code>&lt;name-width&gt;</code> after a comma. The width
3876 of the graph part can be limited by using
3877 <code>--stat-graph-width=&lt;width&gt;</code> (affects all commands generating
3878 a stat graph) or by setting <code>diff.statGraphWidth=&lt;width&gt;</code>
3879 (does not affect <code>git format-patch</code>).
3880 By giving a third parameter <code>&lt;count&gt;</code>, you can limit the
3881 output to the first <code>&lt;count&gt;</code> lines, followed by <code>...</code> if
3882 there are more.
3883 </p>
3884 <div class="paragraph"><p>These parameters can also be set individually with <code>--stat-width=&lt;width&gt;</code>,
3885 <code>--stat-name-width=&lt;name-width&gt;</code> and <code>--stat-count=&lt;count&gt;</code>.</p></div>
3886 </dd>
3887 <dt class="hdlist1">
3888 --compact-summary
3889 </dt>
3890 <dd>
3892 Output a condensed summary of extended header information such
3893 as file creations or deletions ("new" or "gone", optionally "+l"
3894 if it&#8217;s a symlink) and mode changes ("+x" or "-x" for adding
3895 or removing executable bit respectively) in diffstat. The
3896 information is put between the filename part and the graph
3897 part. Implies <code>--stat</code>.
3898 </p>
3899 </dd>
3900 <dt class="hdlist1">
3901 --numstat
3902 </dt>
3903 <dd>
3905 Similar to <code>--stat</code>, but shows number of added and
3906 deleted lines in decimal notation and pathname without
3907 abbreviation, to make it more machine friendly. For
3908 binary files, outputs two <code>-</code> instead of saying
3909 <code>0 0</code>.
3910 </p>
3911 </dd>
3912 <dt class="hdlist1">
3913 --shortstat
3914 </dt>
3915 <dd>
3917 Output only the last line of the <code>--stat</code> format containing total
3918 number of modified files, as well as number of added and deleted
3919 lines.
3920 </p>
3921 </dd>
3922 <dt class="hdlist1">
3923 -X[&lt;param1,param2,&#8230;&gt;]
3924 </dt>
3925 <dt class="hdlist1">
3926 --dirstat[=&lt;param1,param2,&#8230;&gt;]
3927 </dt>
3928 <dd>
3930 Output the distribution of relative amount of changes for each
3931 sub-directory. The behavior of <code>--dirstat</code> can be customized by
3932 passing it a comma separated list of parameters.
3933 The defaults are controlled by the <code>diff.dirstat</code> configuration
3934 variable (see <a href="git-config.html">git-config(1)</a>).
3935 The following parameters are available:
3936 </p>
3937 <div class="openblock">
3938 <div class="content">
3939 <div class="dlist"><dl>
3940 <dt class="hdlist1">
3941 <code>changes</code>
3942 </dt>
3943 <dd>
3945 Compute the dirstat numbers by counting the lines that have been
3946 removed from the source, or added to the destination. This ignores
3947 the amount of pure code movements within a file. In other words,
3948 rearranging lines in a file is not counted as much as other changes.
3949 This is the default behavior when no parameter is given.
3950 </p>
3951 </dd>
3952 <dt class="hdlist1">
3953 <code>lines</code>
3954 </dt>
3955 <dd>
3957 Compute the dirstat numbers by doing the regular line-based diff
3958 analysis, and summing the removed/added line counts. (For binary
3959 files, count 64-byte chunks instead, since binary files have no
3960 natural concept of lines). This is a more expensive <code>--dirstat</code>
3961 behavior than the <code>changes</code> behavior, but it does count rearranged
3962 lines within a file as much as other changes. The resulting output
3963 is consistent with what you get from the other <code>--*stat</code> options.
3964 </p>
3965 </dd>
3966 <dt class="hdlist1">
3967 <code>files</code>
3968 </dt>
3969 <dd>
3971 Compute the dirstat numbers by counting the number of files changed.
3972 Each changed file counts equally in the dirstat analysis. This is
3973 the computationally cheapest <code>--dirstat</code> behavior, since it does
3974 not have to look at the file contents at all.
3975 </p>
3976 </dd>
3977 <dt class="hdlist1">
3978 <code>cumulative</code>
3979 </dt>
3980 <dd>
3982 Count changes in a child directory for the parent directory as well.
3983 Note that when using <code>cumulative</code>, the sum of the percentages
3984 reported may exceed 100%. The default (non-cumulative) behavior can
3985 be specified with the <code>noncumulative</code> parameter.
3986 </p>
3987 </dd>
3988 <dt class="hdlist1">
3989 &lt;limit&gt;
3990 </dt>
3991 <dd>
3993 An integer parameter specifies a cut-off percent (3% by default).
3994 Directories contributing less than this percentage of the changes
3995 are not shown in the output.
3996 </p>
3997 </dd>
3998 </dl></div>
3999 </div></div>
4000 <div class="paragraph"><p>Example: The following will count changed files, while ignoring
4001 directories with less than 10% of the total amount of changed files,
4002 and accumulating child directory counts in the parent directories:
4003 <code>--dirstat=files,10,cumulative</code>.</p></div>
4004 </dd>
4005 <dt class="hdlist1">
4006 --cumulative
4007 </dt>
4008 <dd>
4010 Synonym for --dirstat=cumulative
4011 </p>
4012 </dd>
4013 <dt class="hdlist1">
4014 --dirstat-by-file[=&lt;param1,param2&gt;&#8230;]
4015 </dt>
4016 <dd>
4018 Synonym for --dirstat=files,param1,param2&#8230;
4019 </p>
4020 </dd>
4021 <dt class="hdlist1">
4022 --summary
4023 </dt>
4024 <dd>
4026 Output a condensed summary of extended header information
4027 such as creations, renames and mode changes.
4028 </p>
4029 </dd>
4030 <dt class="hdlist1">
4031 --patch-with-stat
4032 </dt>
4033 <dd>
4035 Synonym for <code>-p --stat</code>.
4036 </p>
4037 </dd>
4038 <dt class="hdlist1">
4040 </dt>
4041 <dd>
4043 Separate the commits with NULs instead of with new newlines.
4044 </p>
4045 <div class="paragraph"><p>Also, when <code>--raw</code> or <code>--numstat</code> has been given, do not munge
4046 pathnames and use NULs as output field terminators.</p></div>
4047 <div class="paragraph"><p>Without this option, pathnames with "unusual" characters are quoted as
4048 explained for the configuration variable <code>core.quotePath</code> (see
4049 <a href="git-config.html">git-config(1)</a>).</p></div>
4050 </dd>
4051 <dt class="hdlist1">
4052 --name-only
4053 </dt>
4054 <dd>
4056 Show only names of changed files. The file names are often encoded in UTF-8.
4057 For more information see the discussion about encoding in the <a href="git-log.html">git-log(1)</a>
4058 manual page.
4059 </p>
4060 </dd>
4061 <dt class="hdlist1">
4062 --name-status
4063 </dt>
4064 <dd>
4066 Show only names and status of changed files. See the description
4067 of the <code>--diff-filter</code> option on what the status letters mean.
4068 Just like <code>--name-only</code> the file names are often encoded in UTF-8.
4069 </p>
4070 </dd>
4071 <dt class="hdlist1">
4072 --submodule[=&lt;format&gt;]
4073 </dt>
4074 <dd>
4076 Specify how differences in submodules are shown. When specifying
4077 <code>--submodule=short</code> the <em>short</em> format is used. This format just
4078 shows the names of the commits at the beginning and end of the range.
4079 When <code>--submodule</code> or <code>--submodule=log</code> is specified, the <em>log</em>
4080 format is used. This format lists the commits in the range like
4081 <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code> does. When <code>--submodule=diff</code>
4082 is specified, the <em>diff</em> format is used. This format shows an
4083 inline diff of the changes in the submodule contents between the
4084 commit range. Defaults to <code>diff.submodule</code> or the <em>short</em> format
4085 if the config option is unset.
4086 </p>
4087 </dd>
4088 <dt class="hdlist1">
4089 --color[=&lt;when&gt;]
4090 </dt>
4091 <dd>
4093 Show colored diff.
4094 <code>--color</code> (i.e. without <em>=&lt;when&gt;</em>) is the same as <code>--color=always</code>.
4095 <em>&lt;when&gt;</em> can be one of <code>always</code>, <code>never</code>, or <code>auto</code>.
4096 </p>
4097 </dd>
4098 <dt class="hdlist1">
4099 --no-color
4100 </dt>
4101 <dd>
4103 Turn off colored diff.
4104 It is the same as <code>--color=never</code>.
4105 </p>
4106 </dd>
4107 <dt class="hdlist1">
4108 --color-moved[=&lt;mode&gt;]
4109 </dt>
4110 <dd>
4112 Moved lines of code are colored differently.
4113 The &lt;mode&gt; defaults to <em>no</em> if the option is not given
4114 and to <em>zebra</em> if the option with no mode is given.
4115 The mode must be one of:
4116 </p>
4117 <div class="openblock">
4118 <div class="content">
4119 <div class="dlist"><dl>
4120 <dt class="hdlist1">
4122 </dt>
4123 <dd>
4125 Moved lines are not highlighted.
4126 </p>
4127 </dd>
4128 <dt class="hdlist1">
4129 default
4130 </dt>
4131 <dd>
4133 Is a synonym for <code>zebra</code>. This may change to a more sensible mode
4134 in the future.
4135 </p>
4136 </dd>
4137 <dt class="hdlist1">
4138 plain
4139 </dt>
4140 <dd>
4142 Any line that is added in one location and was removed
4143 in another location will be colored with <em>color.diff.newMoved</em>.
4144 Similarly <em>color.diff.oldMoved</em> will be used for removed lines
4145 that are added somewhere else in the diff. This mode picks up any
4146 moved line, but it is not very useful in a review to determine
4147 if a block of code was moved without permutation.
4148 </p>
4149 </dd>
4150 <dt class="hdlist1">
4151 blocks
4152 </dt>
4153 <dd>
4155 Blocks of moved text of at least 20 alphanumeric characters
4156 are detected greedily. The detected blocks are
4157 painted using either the <em>color.diff.{old,new}Moved</em> color.
4158 Adjacent blocks cannot be told apart.
4159 </p>
4160 </dd>
4161 <dt class="hdlist1">
4162 zebra
4163 </dt>
4164 <dd>
4166 Blocks of moved text are detected as in <em>blocks</em> mode. The blocks
4167 are painted using either the <em>color.diff.{old,new}Moved</em> color or
4168 <em>color.diff.{old,new}MovedAlternative</em>. The change between
4169 the two colors indicates that a new block was detected.
4170 </p>
4171 </dd>
4172 <dt class="hdlist1">
4173 dimmed-zebra
4174 </dt>
4175 <dd>
4177 Similar to <em>zebra</em>, but additional dimming of uninteresting parts
4178 of moved code is performed. The bordering lines of two adjacent
4179 blocks are considered interesting, the rest is uninteresting.
4180 <code>dimmed_zebra</code> is a deprecated synonym.
4181 </p>
4182 </dd>
4183 </dl></div>
4184 </div></div>
4185 </dd>
4186 <dt class="hdlist1">
4187 --no-color-moved
4188 </dt>
4189 <dd>
4191 Turn off move detection. This can be used to override configuration
4192 settings. It is the same as <code>--color-moved=no</code>.
4193 </p>
4194 </dd>
4195 <dt class="hdlist1">
4196 --color-moved-ws=&lt;modes&gt;
4197 </dt>
4198 <dd>
4200 This configures how whitespace is ignored when performing the
4201 move detection for <code>--color-moved</code>.
4202 These modes can be given as a comma separated list:
4203 </p>
4204 <div class="openblock">
4205 <div class="content">
4206 <div class="dlist"><dl>
4207 <dt class="hdlist1">
4209 </dt>
4210 <dd>
4212 Do not ignore whitespace when performing move detection.
4213 </p>
4214 </dd>
4215 <dt class="hdlist1">
4216 ignore-space-at-eol
4217 </dt>
4218 <dd>
4220 Ignore changes in whitespace at EOL.
4221 </p>
4222 </dd>
4223 <dt class="hdlist1">
4224 ignore-space-change
4225 </dt>
4226 <dd>
4228 Ignore changes in amount of whitespace. This ignores whitespace
4229 at line end, and considers all other sequences of one or
4230 more whitespace characters to be equivalent.
4231 </p>
4232 </dd>
4233 <dt class="hdlist1">
4234 ignore-all-space
4235 </dt>
4236 <dd>
4238 Ignore whitespace when comparing lines. This ignores differences
4239 even if one line has whitespace where the other line has none.
4240 </p>
4241 </dd>
4242 <dt class="hdlist1">
4243 allow-indentation-change
4244 </dt>
4245 <dd>
4247 Initially ignore any whitespace in the move detection, then
4248 group the moved code blocks only into a block if the change in
4249 whitespace is the same per line. This is incompatible with the
4250 other modes.
4251 </p>
4252 </dd>
4253 </dl></div>
4254 </div></div>
4255 </dd>
4256 <dt class="hdlist1">
4257 --no-color-moved-ws
4258 </dt>
4259 <dd>
4261 Do not ignore whitespace when performing move detection. This can be
4262 used to override configuration settings. It is the same as
4263 <code>--color-moved-ws=no</code>.
4264 </p>
4265 </dd>
4266 <dt class="hdlist1">
4267 --word-diff[=&lt;mode&gt;]
4268 </dt>
4269 <dd>
4271 Show a word diff, using the &lt;mode&gt; to delimit changed words.
4272 By default, words are delimited by whitespace; see
4273 <code>--word-diff-regex</code> below. The &lt;mode&gt; defaults to <em>plain</em>, and
4274 must be one of:
4275 </p>
4276 <div class="openblock">
4277 <div class="content">
4278 <div class="dlist"><dl>
4279 <dt class="hdlist1">
4280 color
4281 </dt>
4282 <dd>
4284 Highlight changed words using only colors. Implies <code>--color</code>.
4285 </p>
4286 </dd>
4287 <dt class="hdlist1">
4288 plain
4289 </dt>
4290 <dd>
4292 Show words as <code>[-removed-]</code> and <code>{+added+}</code>. Makes no
4293 attempts to escape the delimiters if they appear in the input,
4294 so the output may be ambiguous.
4295 </p>
4296 </dd>
4297 <dt class="hdlist1">
4298 porcelain
4299 </dt>
4300 <dd>
4302 Use a special line-based format intended for script
4303 consumption. Added/removed/unchanged runs are printed in the
4304 usual unified diff format, starting with a <code>+</code>/<code>-</code>/` `
4305 character at the beginning of the line and extending to the
4306 end of the line. Newlines in the input are represented by a
4307 tilde <code>~</code> on a line of its own.
4308 </p>
4309 </dd>
4310 <dt class="hdlist1">
4311 none
4312 </dt>
4313 <dd>
4315 Disable word diff again.
4316 </p>
4317 </dd>
4318 </dl></div>
4319 </div></div>
4320 <div class="paragraph"><p>Note that despite the name of the first mode, color is used to
4321 highlight the changed parts in all modes if enabled.</p></div>
4322 </dd>
4323 <dt class="hdlist1">
4324 --word-diff-regex=&lt;regex&gt;
4325 </dt>
4326 <dd>
4328 Use &lt;regex&gt; to decide what a word is, instead of considering
4329 runs of non-whitespace to be a word. Also implies
4330 <code>--word-diff</code> unless it was already enabled.
4331 </p>
4332 <div class="paragraph"><p>Every non-overlapping match of the
4333 &lt;regex&gt; is considered a word. Anything between these matches is
4334 considered whitespace and ignored(!) for the purposes of finding
4335 differences. You may want to append <code>|[^[:space:]]</code> to your regular
4336 expression to make sure that it matches all non-whitespace characters.
4337 A match that contains a newline is silently truncated(!) at the
4338 newline.</p></div>
4339 <div class="paragraph"><p>For example, <code>--word-diff-regex=.</code> will treat each character as a word
4340 and, correspondingly, show differences character by character.</p></div>
4341 <div class="paragraph"><p>The regex can also be set via a diff driver or configuration option, see
4342 <a href="gitattributes.html">gitattributes(5)</a> or <a href="git-config.html">git-config(1)</a>. Giving it explicitly
4343 overrides any diff driver or configuration setting. Diff drivers
4344 override configuration settings.</p></div>
4345 </dd>
4346 <dt class="hdlist1">
4347 --color-words[=&lt;regex&gt;]
4348 </dt>
4349 <dd>
4351 Equivalent to <code>--word-diff=color</code> plus (if a regex was
4352 specified) <code>--word-diff-regex=&lt;regex&gt;</code>.
4353 </p>
4354 </dd>
4355 <dt class="hdlist1">
4356 --no-renames
4357 </dt>
4358 <dd>
4360 Turn off rename detection, even when the configuration
4361 file gives the default to do so.
4362 </p>
4363 </dd>
4364 <dt class="hdlist1">
4365 --[no-]rename-empty
4366 </dt>
4367 <dd>
4369 Whether to use empty blobs as rename source.
4370 </p>
4371 </dd>
4372 <dt class="hdlist1">
4373 --check
4374 </dt>
4375 <dd>
4377 Warn if changes introduce conflict markers or whitespace errors.
4378 What are considered whitespace errors is controlled by <code>core.whitespace</code>
4379 configuration. By default, trailing whitespaces (including
4380 lines that consist solely of whitespaces) and a space character
4381 that is immediately followed by a tab character inside the
4382 initial indent of the line are considered whitespace errors.
4383 Exits with non-zero status if problems are found. Not compatible
4384 with --exit-code.
4385 </p>
4386 </dd>
4387 <dt class="hdlist1">
4388 --ws-error-highlight=&lt;kind&gt;
4389 </dt>
4390 <dd>
4392 Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
4393 lines of the diff. Multiple values are separated by comma,
4394 <code>none</code> resets previous values, <code>default</code> reset the list to
4395 <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>. When
4396 this option is not given, and the configuration variable
4397 <code>diff.wsErrorHighlight</code> is not set, only whitespace errors in
4398 <code>new</code> lines are highlighted. The whitespace errors are colored
4399 with <code>color.diff.whitespace</code>.
4400 </p>
4401 </dd>
4402 <dt class="hdlist1">
4403 --full-index
4404 </dt>
4405 <dd>
4407 Instead of the first handful of characters, show the full
4408 pre- and post-image blob object names on the "index"
4409 line when generating patch format output.
4410 </p>
4411 </dd>
4412 <dt class="hdlist1">
4413 --binary
4414 </dt>
4415 <dd>
4417 In addition to <code>--full-index</code>, output a binary diff that
4418 can be applied with <code>git-apply</code>.
4419 Implies <code>--patch</code>.
4420 </p>
4421 </dd>
4422 <dt class="hdlist1">
4423 --abbrev[=&lt;n&gt;]
4424 </dt>
4425 <dd>
4427 Instead of showing the full 40-byte hexadecimal object
4428 name in diff-raw format output and diff-tree header
4429 lines, show the shortest prefix that is at least <em>&lt;n&gt;</em>
4430 hexdigits long that uniquely refers the object.
4431 In diff-patch output format, <code>--full-index</code> takes higher
4432 precedence, i.e. if <code>--full-index</code> is specified, full blob
4433 names will be shown regardless of <code>--abbrev</code>.
4434 Non default number of digits can be specified with <code>--abbrev=&lt;n&gt;</code>.
4435 </p>
4436 </dd>
4437 <dt class="hdlist1">
4438 -B[&lt;n&gt;][/&lt;m&gt;]
4439 </dt>
4440 <dt class="hdlist1">
4441 --break-rewrites[=[&lt;n&gt;][/&lt;m&gt;]]
4442 </dt>
4443 <dd>
4445 Break complete rewrite changes into pairs of delete and
4446 create. This serves two purposes:
4447 </p>
4448 <div class="paragraph"><p>It affects the way a change that amounts to a total rewrite of a file
4449 not as a series of deletion and insertion mixed together with a very
4450 few lines that happen to match textually as the context, but as a
4451 single deletion of everything old followed by a single insertion of
4452 everything new, and the number <code>m</code> controls this aspect of the -B
4453 option (defaults to 60%). <code>-B/70%</code> specifies that less than 30% of the
4454 original should remain in the result for Git to consider it a total
4455 rewrite (i.e. otherwise the resulting patch will be a series of
4456 deletion and insertion mixed together with context lines).</p></div>
4457 <div class="paragraph"><p>When used with -M, a totally-rewritten file is also considered as the
4458 source of a rename (usually -M only considers a file that disappeared
4459 as the source of a rename), and the number <code>n</code> controls this aspect of
4460 the -B option (defaults to 50%). <code>-B20%</code> specifies that a change with
4461 addition and deletion compared to 20% or more of the file&#8217;s size are
4462 eligible for being picked up as a possible source of a rename to
4463 another file.</p></div>
4464 </dd>
4465 <dt class="hdlist1">
4466 -M[&lt;n&gt;]
4467 </dt>
4468 <dt class="hdlist1">
4469 --find-renames[=&lt;n&gt;]
4470 </dt>
4471 <dd>
4473 If generating diffs, detect and report renames for each commit.
4474 For following files across renames while traversing history, see
4475 <code>--follow</code>.
4476 If <code>n</code> is specified, it is a threshold on the similarity
4477 index (i.e. amount of addition/deletions compared to the
4478 file&#8217;s size). For example, <code>-M90%</code> means Git should consider a
4479 delete/add pair to be a rename if more than 90% of the file
4480 hasn&#8217;t changed. Without a <code>%</code> sign, the number is to be read as
4481 a fraction, with a decimal point before it. I.e., <code>-M5</code> becomes
4482 0.5, and is thus the same as <code>-M50%</code>. Similarly, <code>-M05</code> is
4483 the same as <code>-M5%</code>. To limit detection to exact renames, use
4484 <code>-M100%</code>. The default similarity index is 50%.
4485 </p>
4486 </dd>
4487 <dt class="hdlist1">
4488 -C[&lt;n&gt;]
4489 </dt>
4490 <dt class="hdlist1">
4491 --find-copies[=&lt;n&gt;]
4492 </dt>
4493 <dd>
4495 Detect copies as well as renames. See also <code>--find-copies-harder</code>.
4496 If <code>n</code> is specified, it has the same meaning as for <code>-M&lt;n&gt;</code>.
4497 </p>
4498 </dd>
4499 <dt class="hdlist1">
4500 --find-copies-harder
4501 </dt>
4502 <dd>
4504 For performance reasons, by default, <code>-C</code> option finds copies only
4505 if the original file of the copy was modified in the same
4506 changeset. This flag makes the command
4507 inspect unmodified files as candidates for the source of
4508 copy. This is a very expensive operation for large
4509 projects, so use it with caution. Giving more than one
4510 <code>-C</code> option has the same effect.
4511 </p>
4512 </dd>
4513 <dt class="hdlist1">
4515 </dt>
4516 <dt class="hdlist1">
4517 --irreversible-delete
4518 </dt>
4519 <dd>
4521 Omit the preimage for deletes, i.e. print only the header but not
4522 the diff between the preimage and <code>/dev/null</code>. The resulting patch
4523 is not meant to be applied with <code>patch</code> or <code>git apply</code>; this is
4524 solely for people who want to just concentrate on reviewing the
4525 text after the change. In addition, the output obviously lacks
4526 enough information to apply such a patch in reverse, even manually,
4527 hence the name of the option.
4528 </p>
4529 <div class="paragraph"><p>When used together with <code>-B</code>, omit also the preimage in the deletion part
4530 of a delete/create pair.</p></div>
4531 </dd>
4532 <dt class="hdlist1">
4533 -l&lt;num&gt;
4534 </dt>
4535 <dd>
4537 The <code>-M</code> and <code>-C</code> options involve some preliminary steps that
4538 can detect subsets of renames/copies cheaply, followed by an
4539 exhaustive fallback portion that compares all remaining
4540 unpaired destinations to all relevant sources. (For renames,
4541 only remaining unpaired sources are relevant; for copies, all
4542 original sources are relevant.) For N sources and
4543 destinations, this exhaustive check is O(N^2). This option
4544 prevents the exhaustive portion of rename/copy detection from
4545 running if the number of source/destination files involved
4546 exceeds the specified number. Defaults to diff.renameLimit.
4547 Note that a value of 0 is treated as unlimited.
4548 </p>
4549 </dd>
4550 <dt class="hdlist1">
4551 --diff-filter=[(A|C|D|M|R|T|U|X|B)&#8230;[*]]
4552 </dt>
4553 <dd>
4555 Select only files that are Added (<code>A</code>), Copied (<code>C</code>),
4556 Deleted (<code>D</code>), Modified (<code>M</code>), Renamed (<code>R</code>), have their
4557 type (i.e. regular file, symlink, submodule, &#8230;) changed (<code>T</code>),
4558 are Unmerged (<code>U</code>), are
4559 Unknown (<code>X</code>), or have had their pairing Broken (<code>B</code>).
4560 Any combination of the filter characters (including none) can be used.
4561 When <code>*</code> (All-or-none) is added to the combination, all
4562 paths are selected if there is any file that matches
4563 other criteria in the comparison; if there is no file
4564 that matches other criteria, nothing is selected.
4565 </p>
4566 <div class="paragraph"><p>Also, these upper-case letters can be downcased to exclude. E.g.
4567 <code>--diff-filter=ad</code> excludes added and deleted paths.</p></div>
4568 <div class="paragraph"><p>Note that not all diffs can feature all types. For instance, copied and
4569 renamed entries cannot appear if detection for those types is disabled.</p></div>
4570 </dd>
4571 <dt class="hdlist1">
4572 -S&lt;string&gt;
4573 </dt>
4574 <dd>
4576 Look for differences that change the number of occurrences of
4577 the specified string (i.e. addition/deletion) in a file.
4578 Intended for the scripter&#8217;s use.
4579 </p>
4580 <div class="paragraph"><p>It is useful when you&#8217;re looking for an exact block of code (like a
4581 struct), and want to know the history of that block since it first
4582 came into being: use the feature iteratively to feed the interesting
4583 block in the preimage back into <code>-S</code>, and keep going until you get the
4584 very first version of the block.</p></div>
4585 <div class="paragraph"><p>Binary files are searched as well.</p></div>
4586 </dd>
4587 <dt class="hdlist1">
4588 -G&lt;regex&gt;
4589 </dt>
4590 <dd>
4592 Look for differences whose patch text contains added/removed
4593 lines that match &lt;regex&gt;.
4594 </p>
4595 <div class="paragraph"><p>To illustrate the difference between <code>-S&lt;regex&gt; --pickaxe-regex</code> and
4596 <code>-G&lt;regex&gt;</code>, consider a commit with the following diff in the same
4597 file:</p></div>
4598 <div class="listingblock">
4599 <div class="content">
4600 <pre><code>+ return frotz(nitfol, two-&gt;ptr, 1, 0);
4602 - hit = frotz(nitfol, mf2.ptr, 1, 0);</code></pre>
4603 </div></div>
4604 <div class="paragraph"><p>While <code>git log -G"frotz\(nitfol"</code> will show this commit, <code>git log
4605 -S"frotz\(nitfol" --pickaxe-regex</code> will not (because the number of
4606 occurrences of that string did not change).</p></div>
4607 <div class="paragraph"><p>Unless <code>--text</code> is supplied patches of binary files without a textconv
4608 filter will be ignored.</p></div>
4609 <div class="paragraph"><p>See the <em>pickaxe</em> entry in <a href="gitdiffcore.html">gitdiffcore(7)</a> for more
4610 information.</p></div>
4611 </dd>
4612 <dt class="hdlist1">
4613 --find-object=&lt;object-id&gt;
4614 </dt>
4615 <dd>
4617 Look for differences that change the number of occurrences of
4618 the specified object. Similar to <code>-S</code>, just the argument is different
4619 in that it doesn&#8217;t search for a specific string but for a specific
4620 object id.
4621 </p>
4622 <div class="paragraph"><p>The object can be a blob or a submodule commit. It implies the <code>-t</code> option in
4623 <code>git-log</code> to also find trees.</p></div>
4624 </dd>
4625 <dt class="hdlist1">
4626 --pickaxe-all
4627 </dt>
4628 <dd>
4630 When <code>-S</code> or <code>-G</code> finds a change, show all the changes in that
4631 changeset, not just the files that contain the change
4632 in &lt;string&gt;.
4633 </p>
4634 </dd>
4635 <dt class="hdlist1">
4636 --pickaxe-regex
4637 </dt>
4638 <dd>
4640 Treat the &lt;string&gt; given to <code>-S</code> as an extended POSIX regular
4641 expression to match.
4642 </p>
4643 </dd>
4644 <dt class="hdlist1">
4645 -O&lt;orderfile&gt;
4646 </dt>
4647 <dd>
4649 Control the order in which files appear in the output.
4650 This overrides the <code>diff.orderFile</code> configuration variable
4651 (see <a href="git-config.html">git-config(1)</a>). To cancel <code>diff.orderFile</code>,
4652 use <code>-O/dev/null</code>.
4653 </p>
4654 <div class="paragraph"><p>The output order is determined by the order of glob patterns in
4655 &lt;orderfile&gt;.
4656 All files with pathnames that match the first pattern are output
4657 first, all files with pathnames that match the second pattern (but not
4658 the first) are output next, and so on.
4659 All files with pathnames that do not match any pattern are output
4660 last, as if there was an implicit match-all pattern at the end of the
4661 file.
4662 If multiple pathnames have the same rank (they match the same pattern
4663 but no earlier patterns), their output order relative to each other is
4664 the normal order.</p></div>
4665 <div class="paragraph"><p>&lt;orderfile&gt; is parsed as follows:</p></div>
4666 <div class="openblock">
4667 <div class="content">
4668 <div class="ulist"><ul>
4669 <li>
4671 Blank lines are ignored, so they can be used as separators for
4672 readability.
4673 </p>
4674 </li>
4675 <li>
4677 Lines starting with a hash ("<code>#</code>") are ignored, so they can be used
4678 for comments. Add a backslash ("<code>\</code>") to the beginning of the
4679 pattern if it starts with a hash.
4680 </p>
4681 </li>
4682 <li>
4684 Each other line contains a single pattern.
4685 </p>
4686 </li>
4687 </ul></div>
4688 </div></div>
4689 <div class="paragraph"><p>Patterns have the same syntax and semantics as patterns used for
4690 fnmatch(3) without the FNM_PATHNAME flag, except a pathname also
4691 matches a pattern if removing any number of the final pathname
4692 components matches the pattern. For example, the pattern "<code>foo*bar</code>"
4693 matches "<code>fooasdfbar</code>" and "<code>foo/bar/baz/asdf</code>" but not "<code>foobarx</code>".</p></div>
4694 </dd>
4695 <dt class="hdlist1">
4696 --skip-to=&lt;file&gt;
4697 </dt>
4698 <dt class="hdlist1">
4699 --rotate-to=&lt;file&gt;
4700 </dt>
4701 <dd>
4703 Discard the files before the named &lt;file&gt; from the output
4704 (i.e. <em>skip to</em>), or move them to the end of the output
4705 (i.e. <em>rotate to</em>). These were invented primarily for use
4706 of the <code>git difftool</code> command, and may not be very useful
4707 otherwise.
4708 </p>
4709 </dd>
4710 <dt class="hdlist1">
4712 </dt>
4713 <dd>
4715 Swap two inputs; that is, show differences from index or
4716 on-disk file to tree contents.
4717 </p>
4718 </dd>
4719 <dt class="hdlist1">
4720 --relative[=&lt;path&gt;]
4721 </dt>
4722 <dt class="hdlist1">
4723 --no-relative
4724 </dt>
4725 <dd>
4727 When run from a subdirectory of the project, it can be
4728 told to exclude changes outside the directory and show
4729 pathnames relative to it with this option. When you are
4730 not in a subdirectory (e.g. in a bare repository), you
4731 can name which subdirectory to make the output relative
4732 to by giving a &lt;path&gt; as an argument.
4733 <code>--no-relative</code> can be used to countermand both <code>diff.relative</code> config
4734 option and previous <code>--relative</code>.
4735 </p>
4736 </dd>
4737 <dt class="hdlist1">
4739 </dt>
4740 <dt class="hdlist1">
4741 --text
4742 </dt>
4743 <dd>
4745 Treat all files as text.
4746 </p>
4747 </dd>
4748 <dt class="hdlist1">
4749 --ignore-cr-at-eol
4750 </dt>
4751 <dd>
4753 Ignore carriage-return at the end of line when doing a comparison.
4754 </p>
4755 </dd>
4756 <dt class="hdlist1">
4757 --ignore-space-at-eol
4758 </dt>
4759 <dd>
4761 Ignore changes in whitespace at EOL.
4762 </p>
4763 </dd>
4764 <dt class="hdlist1">
4766 </dt>
4767 <dt class="hdlist1">
4768 --ignore-space-change
4769 </dt>
4770 <dd>
4772 Ignore changes in amount of whitespace. This ignores whitespace
4773 at line end, and considers all other sequences of one or
4774 more whitespace characters to be equivalent.
4775 </p>
4776 </dd>
4777 <dt class="hdlist1">
4779 </dt>
4780 <dt class="hdlist1">
4781 --ignore-all-space
4782 </dt>
4783 <dd>
4785 Ignore whitespace when comparing lines. This ignores
4786 differences even if one line has whitespace where the other
4787 line has none.
4788 </p>
4789 </dd>
4790 <dt class="hdlist1">
4791 --ignore-blank-lines
4792 </dt>
4793 <dd>
4795 Ignore changes whose lines are all blank.
4796 </p>
4797 </dd>
4798 <dt class="hdlist1">
4799 -I&lt;regex&gt;
4800 </dt>
4801 <dt class="hdlist1">
4802 --ignore-matching-lines=&lt;regex&gt;
4803 </dt>
4804 <dd>
4806 Ignore changes whose all lines match &lt;regex&gt;. This option may
4807 be specified more than once.
4808 </p>
4809 </dd>
4810 <dt class="hdlist1">
4811 --inter-hunk-context=&lt;lines&gt;
4812 </dt>
4813 <dd>
4815 Show the context between diff hunks, up to the specified number
4816 of lines, thereby fusing hunks that are close to each other.
4817 Defaults to <code>diff.interHunkContext</code> or 0 if the config option
4818 is unset.
4819 </p>
4820 </dd>
4821 <dt class="hdlist1">
4823 </dt>
4824 <dt class="hdlist1">
4825 --function-context
4826 </dt>
4827 <dd>
4829 Show whole function as context lines for each change.
4830 The function names are determined in the same way as
4831 <code>git diff</code> works out patch hunk headers (see <em>Defining a
4832 custom hunk-header</em> in <a href="gitattributes.html">gitattributes(5)</a>).
4833 </p>
4834 </dd>
4835 <dt class="hdlist1">
4836 --ext-diff
4837 </dt>
4838 <dd>
4840 Allow an external diff helper to be executed. If you set an
4841 external diff driver with <a href="gitattributes.html">gitattributes(5)</a>, you need
4842 to use this option with <a href="git-log.html">git-log(1)</a> and friends.
4843 </p>
4844 </dd>
4845 <dt class="hdlist1">
4846 --no-ext-diff
4847 </dt>
4848 <dd>
4850 Disallow external diff drivers.
4851 </p>
4852 </dd>
4853 <dt class="hdlist1">
4854 --textconv
4855 </dt>
4856 <dt class="hdlist1">
4857 --no-textconv
4858 </dt>
4859 <dd>
4861 Allow (or disallow) external text conversion filters to be run
4862 when comparing binary files. See <a href="gitattributes.html">gitattributes(5)</a> for
4863 details. Because textconv filters are typically a one-way
4864 conversion, the resulting diff is suitable for human
4865 consumption, but cannot be applied. For this reason, textconv
4866 filters are enabled by default only for <a href="git-diff.html">git-diff(1)</a> and
4867 <a href="git-log.html">git-log(1)</a>, but not for <a href="git-format-patch.html">git-format-patch(1)</a> or
4868 diff plumbing commands.
4869 </p>
4870 </dd>
4871 <dt class="hdlist1">
4872 --ignore-submodules[=&lt;when&gt;]
4873 </dt>
4874 <dd>
4876 Ignore changes to submodules in the diff generation. &lt;when&gt; can be
4877 either "none", "untracked", "dirty" or "all", which is the default.
4878 Using "none" will consider the submodule modified when it either contains
4879 untracked or modified files or its HEAD differs from the commit recorded
4880 in the superproject and can be used to override any settings of the
4881 <em>ignore</em> option in <a href="git-config.html">git-config(1)</a> or <a href="gitmodules.html">gitmodules(5)</a>. When
4882 "untracked" is used submodules are not considered dirty when they only
4883 contain untracked content (but they are still scanned for modified
4884 content). Using "dirty" ignores all changes to the work tree of submodules,
4885 only changes to the commits stored in the superproject are shown (this was
4886 the behavior until 1.7.0). Using "all" hides all changes to submodules.
4887 </p>
4888 </dd>
4889 <dt class="hdlist1">
4890 --src-prefix=&lt;prefix&gt;
4891 </dt>
4892 <dd>
4894 Show the given source prefix instead of "a/".
4895 </p>
4896 </dd>
4897 <dt class="hdlist1">
4898 --dst-prefix=&lt;prefix&gt;
4899 </dt>
4900 <dd>
4902 Show the given destination prefix instead of "b/".
4903 </p>
4904 </dd>
4905 <dt class="hdlist1">
4906 --no-prefix
4907 </dt>
4908 <dd>
4910 Do not show any source or destination prefix.
4911 </p>
4912 </dd>
4913 <dt class="hdlist1">
4914 --default-prefix
4915 </dt>
4916 <dd>
4918 Use the default source and destination prefixes ("a/" and "b/").
4919 This is usually the default already, but may be used to override
4920 config such as <code>diff.noprefix</code>.
4921 </p>
4922 </dd>
4923 <dt class="hdlist1">
4924 --line-prefix=&lt;prefix&gt;
4925 </dt>
4926 <dd>
4928 Prepend an additional prefix to every line of output.
4929 </p>
4930 </dd>
4931 <dt class="hdlist1">
4932 --ita-invisible-in-index
4933 </dt>
4934 <dd>
4936 By default entries added by "git add -N" appear as an existing
4937 empty file in "git diff" and a new file in "git diff --cached".
4938 This option makes the entry appear as a new file in "git diff"
4939 and non-existent in "git diff --cached". This option could be
4940 reverted with <code>--ita-visible-in-index</code>. Both options are
4941 experimental and could be removed in future.
4942 </p>
4943 </dd>
4944 </dl></div>
4945 <div class="paragraph"><p>For more detailed explanation on these common options, see also
4946 <a href="gitdiffcore.html">gitdiffcore(7)</a>.</p></div>
4947 </div>
4948 </div>
4949 <div class="sect1">
4950 <h2 id="generate_patch_text_with_p">Generating patch text with -p</h2>
4951 <div class="sectionbody">
4952 <div class="paragraph"><p>Running
4953 <a href="git-diff.html">git-diff(1)</a>,
4954 <a href="git-log.html">git-log(1)</a>,
4955 <a href="git-show.html">git-show(1)</a>,
4956 <a href="git-diff-index.html">git-diff-index(1)</a>,
4957 <a href="git-diff-tree.html">git-diff-tree(1)</a>, or
4958 <a href="git-diff-files.html">git-diff-files(1)</a>
4959 with the <code>-p</code> option produces patch text.
4960 You can customize the creation of patch text via the
4961 <code>GIT_EXTERNAL_DIFF</code> and the <code>GIT_DIFF_OPTS</code> environment variables
4962 (see <a href="git.html">git(1)</a>), and the <code>diff</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).</p></div>
4963 <div class="paragraph"><p>What the -p option produces is slightly different from the traditional
4964 diff format:</p></div>
4965 <div class="olist arabic"><ol class="arabic">
4966 <li>
4968 It is preceded with a "git diff" header that looks like this:
4969 </p>
4970 <div class="literalblock">
4971 <div class="content">
4972 <pre><code>diff --git a/file1 b/file2</code></pre>
4973 </div></div>
4974 <div class="paragraph"><p>The <code>a/</code> and <code>b/</code> filenames are the same unless rename/copy is
4975 involved. Especially, even for a creation or a deletion,
4976 <code>/dev/null</code> is <em>not</em> used in place of the <code>a/</code> or <code>b/</code> filenames.</p></div>
4977 <div class="paragraph"><p>When rename/copy is involved, <code>file1</code> and <code>file2</code> show the
4978 name of the source file of the rename/copy and the name of
4979 the file that rename/copy produces, respectively.</p></div>
4980 </li>
4981 <li>
4983 It is followed by one or more extended header lines:
4984 </p>
4985 <div class="literalblock">
4986 <div class="content">
4987 <pre><code>old mode &lt;mode&gt;
4988 new mode &lt;mode&gt;
4989 deleted file mode &lt;mode&gt;
4990 new file mode &lt;mode&gt;
4991 copy from &lt;path&gt;
4992 copy to &lt;path&gt;
4993 rename from &lt;path&gt;
4994 rename to &lt;path&gt;
4995 similarity index &lt;number&gt;
4996 dissimilarity index &lt;number&gt;
4997 index &lt;hash&gt;..&lt;hash&gt; &lt;mode&gt;</code></pre>
4998 </div></div>
4999 <div class="paragraph"><p>File modes are printed as 6-digit octal numbers including the file type
5000 and file permission bits.</p></div>
5001 <div class="paragraph"><p>Path names in extended headers do not include the <code>a/</code> and <code>b/</code> prefixes.</p></div>
5002 <div class="paragraph"><p>The similarity index is the percentage of unchanged lines, and
5003 the dissimilarity index is the percentage of changed lines. It
5004 is a rounded down integer, followed by a percent sign. The
5005 similarity index value of 100% is thus reserved for two equal
5006 files, while 100% dissimilarity means that no line from the old
5007 file made it into the new one.</p></div>
5008 <div class="paragraph"><p>The index line includes the blob object names before and after the change.
5009 The &lt;mode&gt; is included if the file mode does not change; otherwise,
5010 separate lines indicate the old and the new mode.</p></div>
5011 </li>
5012 <li>
5014 Pathnames with "unusual" characters are quoted as explained for
5015 the configuration variable <code>core.quotePath</code> (see
5016 <a href="git-config.html">git-config(1)</a>).
5017 </p>
5018 </li>
5019 <li>
5021 All the <code>file1</code> files in the output refer to files before the
5022 commit, and all the <code>file2</code> files refer to files after the commit.
5023 It is incorrect to apply each change to each file sequentially. For
5024 example, this patch will swap a and b:
5025 </p>
5026 <div class="literalblock">
5027 <div class="content">
5028 <pre><code>diff --git a/a b/b
5029 rename from a
5030 rename to b
5031 diff --git a/b b/a
5032 rename from b
5033 rename to a</code></pre>
5034 </div></div>
5035 </li>
5036 <li>
5038 Hunk headers mention the name of the function to which the hunk
5039 applies. See "Defining a custom hunk-header" in
5040 <a href="gitattributes.html">gitattributes(5)</a> for details of how to tailor to this to
5041 specific languages.
5042 </p>
5043 </li>
5044 </ol></div>
5045 </div>
5046 </div>
5047 <div class="sect1">
5048 <h2 id="_combined_diff_format">Combined diff format</h2>
5049 <div class="sectionbody">
5050 <div class="paragraph"><p>Any diff-generating command can take the <code>-c</code> or <code>--cc</code> option to
5051 produce a <em>combined diff</em> when showing a merge. This is the default
5052 format when showing merges with <a href="git-diff.html">git-diff(1)</a> or
5053 <a href="git-show.html">git-show(1)</a>. Note also that you can give suitable
5054 <code>--diff-merges</code> option to any of these commands to force generation of
5055 diffs in specific format.</p></div>
5056 <div class="paragraph"><p>A "combined diff" format looks like this:</p></div>
5057 <div class="listingblock">
5058 <div class="content">
5059 <pre><code>diff --combined describe.c
5060 index fabadb8,cc95eb0..4866510
5061 --- a/describe.c
5062 +++ b/describe.c
5063 @@@ -98,20 -98,12 +98,20 @@@
5064 return (a_date &gt; b_date) ? -1 : (a_date == b_date) ? 0 : 1;
5067 - static void describe(char *arg)
5068 -static void describe(struct commit *cmit, int last_one)
5069 ++static void describe(char *arg, int last_one)
5071 + unsigned char sha1[20];
5072 + struct commit *cmit;
5073 struct commit_list *list;
5074 static int initialized = 0;
5075 struct commit_name *n;
5077 + if (get_sha1(arg, sha1) &lt; 0)
5078 + usage(describe_usage);
5079 + cmit = lookup_commit_reference(sha1);
5080 + if (!cmit)
5081 + usage(describe_usage);
5083 if (!initialized) {
5084 initialized = 1;
5085 for_each_ref(get_name);</code></pre>
5086 </div></div>
5087 <div class="olist arabic"><ol class="arabic">
5088 <li>
5090 It is preceded with a "git diff" header, that looks like
5091 this (when the <code>-c</code> option is used):
5092 </p>
5093 <div class="literalblock">
5094 <div class="content">
5095 <pre><code>diff --combined file</code></pre>
5096 </div></div>
5097 <div class="paragraph"><p>or like this (when the <code>--cc</code> option is used):</p></div>
5098 <div class="literalblock">
5099 <div class="content">
5100 <pre><code>diff --cc file</code></pre>
5101 </div></div>
5102 </li>
5103 <li>
5105 It is followed by one or more extended header lines
5106 (this example shows a merge with two parents):
5107 </p>
5108 <div class="literalblock">
5109 <div class="content">
5110 <pre><code>index &lt;hash&gt;,&lt;hash&gt;..&lt;hash&gt;
5111 mode &lt;mode&gt;,&lt;mode&gt;..&lt;mode&gt;
5112 new file mode &lt;mode&gt;
5113 deleted file mode &lt;mode&gt;,&lt;mode&gt;</code></pre>
5114 </div></div>
5115 <div class="paragraph"><p>The <code>mode &lt;mode&gt;,&lt;mode&gt;..&lt;mode&gt;</code> line appears only if at least one of
5116 the &lt;mode&gt; is different from the rest. Extended headers with
5117 information about detected contents movement (renames and
5118 copying detection) are designed to work with diff of two
5119 &lt;tree-ish&gt; and are not used by combined diff format.</p></div>
5120 </li>
5121 <li>
5123 It is followed by two-line from-file/to-file header
5124 </p>
5125 <div class="literalblock">
5126 <div class="content">
5127 <pre><code>--- a/file
5128 +++ b/file</code></pre>
5129 </div></div>
5130 <div class="paragraph"><p>Similar to two-line header for traditional <em>unified</em> diff
5131 format, <code>/dev/null</code> is used to signal created or deleted
5132 files.</p></div>
5133 <div class="paragraph"><p>However, if the --combined-all-paths option is provided, instead of a
5134 two-line from-file/to-file you get a N+1 line from-file/to-file header,
5135 where N is the number of parents in the merge commit</p></div>
5136 <div class="literalblock">
5137 <div class="content">
5138 <pre><code>--- a/file
5139 --- a/file
5140 --- a/file
5141 +++ b/file</code></pre>
5142 </div></div>
5143 <div class="paragraph"><p>This extended format can be useful if rename or copy detection is
5144 active, to allow you to see the original name of the file in different
5145 parents.</p></div>
5146 </li>
5147 <li>
5149 Chunk header format is modified to prevent people from
5150 accidentally feeding it to <code>patch -p1</code>. Combined diff format
5151 was created for review of merge commit changes, and was not
5152 meant to be applied. The change is similar to the change in the
5153 extended <em>index</em> header:
5154 </p>
5155 <div class="literalblock">
5156 <div class="content">
5157 <pre><code>@@@ &lt;from-file-range&gt; &lt;from-file-range&gt; &lt;to-file-range&gt; @@@</code></pre>
5158 </div></div>
5159 <div class="paragraph"><p>There are (number of parents + 1) <code>@</code> characters in the chunk
5160 header for combined diff format.</p></div>
5161 </li>
5162 </ol></div>
5163 <div class="paragraph"><p>Unlike the traditional <em>unified</em> diff format, which shows two
5164 files A and B with a single column that has <code>-</code> (minus&#8201;&#8212;&#8201;appears in A but removed in B), <code>+</code> (plus&#8201;&#8212;&#8201;missing in A but
5165 added to B), or <code>" "</code> (space&#8201;&#8212;&#8201;unchanged) prefix, this format
5166 compares two or more files file1, file2,&#8230; with one file X, and
5167 shows how X differs from each of fileN. One column for each of
5168 fileN is prepended to the output line to note how X&#8217;s line is
5169 different from it.</p></div>
5170 <div class="paragraph"><p>A <code>-</code> character in the column N means that the line appears in
5171 fileN but it does not appear in the result. A <code>+</code> character
5172 in the column N means that the line appears in the result,
5173 and fileN does not have that line (in other words, the line was
5174 added, from the point of view of that parent).</p></div>
5175 <div class="paragraph"><p>In the above example output, the function signature was changed
5176 from both files (hence two <code>-</code> removals from both file1 and
5177 file2, plus <code>++</code> to mean one line that was added does not appear
5178 in either file1 or file2). Also eight other lines are the same
5179 from file1 but do not appear in file2 (hence prefixed with <code>+</code>).</p></div>
5180 <div class="paragraph"><p>When shown by <code>git diff-tree -c</code>, it compares the parents of a
5181 merge commit with the merge result (i.e. file1..fileN are the
5182 parents). When shown by <code>git diff-files -c</code>, it compares the
5183 two unresolved merge parents with the working tree file
5184 (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka
5185 "their version").</p></div>
5186 </div>
5187 </div>
5188 <div class="sect1">
5189 <h2 id="_examples">EXAMPLES</h2>
5190 <div class="sectionbody">
5191 <div class="dlist"><dl>
5192 <dt class="hdlist1">
5193 <code>git log --no-merges</code>
5194 </dt>
5195 <dd>
5197 Show the whole commit history, but skip any merges
5198 </p>
5199 </dd>
5200 <dt class="hdlist1">
5201 <code>git log v2.6.12.. include/scsi drivers/scsi</code>
5202 </dt>
5203 <dd>
5205 Show all commits since version <em>v2.6.12</em> that changed any file
5206 in the <code>include/scsi</code> or <code>drivers/scsi</code> subdirectories
5207 </p>
5208 </dd>
5209 <dt class="hdlist1">
5210 <code>git log --since="2 weeks ago" -- gitk</code>
5211 </dt>
5212 <dd>
5214 Show the changes during the last two weeks to the file <em>gitk</em>.
5215 The <code>--</code> is necessary to avoid confusion with the <strong>branch</strong> named
5216 <em>gitk</em>
5217 </p>
5218 </dd>
5219 <dt class="hdlist1">
5220 <code>git log --name-status release..test</code>
5221 </dt>
5222 <dd>
5224 Show the commits that are in the "test" branch but not yet
5225 in the "release" branch, along with the list of paths
5226 each commit modifies.
5227 </p>
5228 </dd>
5229 <dt class="hdlist1">
5230 <code>git log --follow builtin/rev-list.c</code>
5231 </dt>
5232 <dd>
5234 Shows the commits that changed <code>builtin/rev-list.c</code>, including
5235 those commits that occurred before the file was given its
5236 present name.
5237 </p>
5238 </dd>
5239 <dt class="hdlist1">
5240 <code>git log --branches --not --remotes=origin</code>
5241 </dt>
5242 <dd>
5244 Shows all commits that are in any of local branches but not in
5245 any of remote-tracking branches for <em>origin</em> (what you have that
5246 origin doesn&#8217;t).
5247 </p>
5248 </dd>
5249 <dt class="hdlist1">
5250 <code>git log master --not --remotes=*/master</code>
5251 </dt>
5252 <dd>
5254 Shows all commits that are in local master but not in any remote
5255 repository master branches.
5256 </p>
5257 </dd>
5258 <dt class="hdlist1">
5259 <code>git log -p -m --first-parent</code>
5260 </dt>
5261 <dd>
5263 Shows the history including change diffs, but only from the
5264 &#8220;main branch&#8221; perspective, skipping commits that come from merged
5265 branches, and showing full diffs of changes introduced by the merges.
5266 This makes sense only when following a strict policy of merging all
5267 topic branches when staying on a single integration branch.
5268 </p>
5269 </dd>
5270 <dt class="hdlist1">
5271 <code>git log -L '/int main/',/^}/:main.c</code>
5272 </dt>
5273 <dd>
5275 Shows how the function <code>main()</code> in the file <code>main.c</code> evolved
5276 over time.
5277 </p>
5278 </dd>
5279 <dt class="hdlist1">
5280 <code>git log -3</code>
5281 </dt>
5282 <dd>
5284 Limits the number of commits to show to 3.
5285 </p>
5286 </dd>
5287 </dl></div>
5288 </div>
5289 </div>
5290 <div class="sect1">
5291 <h2 id="_discussion">DISCUSSION</h2>
5292 <div class="sectionbody">
5293 <div class="paragraph"><p>Git is to some extent character encoding agnostic.</p></div>
5294 <div class="ulist"><ul>
5295 <li>
5297 The contents of the blob objects are uninterpreted sequences
5298 of bytes. There is no encoding translation at the core
5299 level.
5300 </p>
5301 </li>
5302 <li>
5304 Path names are encoded in UTF-8 normalization form C. This
5305 applies to tree objects, the index file, ref names, as well as
5306 path names in command line arguments, environment variables
5307 and config files (<code>.git/config</code> (see <a href="git-config.html">git-config(1)</a>),
5308 <a href="gitignore.html">gitignore(5)</a>, <a href="gitattributes.html">gitattributes(5)</a> and
5309 <a href="gitmodules.html">gitmodules(5)</a>).
5310 </p>
5311 <div class="paragraph"><p>Note that Git at the core level treats path names simply as
5312 sequences of non-NUL bytes, there are no path name encoding
5313 conversions (except on Mac and Windows). Therefore, using
5314 non-ASCII path names will mostly work even on platforms and file
5315 systems that use legacy extended ASCII encodings. However,
5316 repositories created on such systems will not work properly on
5317 UTF-8-based systems (e.g. Linux, Mac, Windows) and vice versa.
5318 Additionally, many Git-based tools simply assume path names to
5319 be UTF-8 and will fail to display other encodings correctly.</p></div>
5320 </li>
5321 <li>
5323 Commit log messages are typically encoded in UTF-8, but other
5324 extended ASCII encodings are also supported. This includes
5325 ISO-8859-x, CP125x and many others, but <em>not</em> UTF-16/32,
5326 EBCDIC and CJK multi-byte encodings (GBK, Shift-JIS, Big5,
5327 EUC-x, CP9xx etc.).
5328 </p>
5329 </li>
5330 </ul></div>
5331 <div class="paragraph"><p>Although we encourage that the commit log messages are encoded
5332 in UTF-8, both the core and Git Porcelain are designed not to
5333 force UTF-8 on projects. If all participants of a particular
5334 project find it more convenient to use legacy encodings, Git
5335 does not forbid it. However, there are a few things to keep in
5336 mind.</p></div>
5337 <div class="olist arabic"><ol class="arabic">
5338 <li>
5340 <em>git commit</em> and <em>git commit-tree</em> issues
5341 a warning if the commit log message given to it does not look
5342 like a valid UTF-8 string, unless you explicitly say your
5343 project uses a legacy encoding. The way to say this is to
5344 have <code>i18n.commitEncoding</code> in <code>.git/config</code> file, like this:
5345 </p>
5346 <div class="listingblock">
5347 <div class="content">
5348 <pre><code>[i18n]
5349 commitEncoding = ISO-8859-1</code></pre>
5350 </div></div>
5351 <div class="paragraph"><p>Commit objects created with the above setting record the value
5352 of <code>i18n.commitEncoding</code> in its <code>encoding</code> header. This is to
5353 help other people who look at them later. Lack of this header
5354 implies that the commit log message is encoded in UTF-8.</p></div>
5355 </li>
5356 <li>
5358 <em>git log</em>, <em>git show</em>, <em>git blame</em> and friends look at the
5359 <code>encoding</code> header of a commit object, and try to re-code the
5360 log message into UTF-8 unless otherwise specified. You can
5361 specify the desired output encoding with
5362 <code>i18n.logOutputEncoding</code> in <code>.git/config</code> file, like this:
5363 </p>
5364 <div class="listingblock">
5365 <div class="content">
5366 <pre><code>[i18n]
5367 logOutputEncoding = ISO-8859-1</code></pre>
5368 </div></div>
5369 <div class="paragraph"><p>If you do not have this configuration variable, the value of
5370 <code>i18n.commitEncoding</code> is used instead.</p></div>
5371 </li>
5372 </ol></div>
5373 <div class="paragraph"><p>Note that we deliberately chose not to re-code the commit log
5374 message when a commit is made to force UTF-8 at the commit
5375 object level, because re-coding to UTF-8 is not necessarily a
5376 reversible operation.</p></div>
5377 </div>
5378 </div>
5379 <div class="sect1">
5380 <h2 id="_configuration">CONFIGURATION</h2>
5381 <div class="sectionbody">
5382 <div class="paragraph"><p>See <a href="git-config.html">git-config(1)</a> for core variables and <a href="git-diff.html">git-diff(1)</a>
5383 for settings related to diff generation.</p></div>
5384 <div class="dlist"><dl>
5385 <dt class="hdlist1">
5386 format.pretty
5387 </dt>
5388 <dd>
5390 Default for the <code>--format</code> option. (See <em>Pretty Formats</em> above.)
5391 Defaults to <code>medium</code>.
5392 </p>
5393 </dd>
5394 <dt class="hdlist1">
5395 i18n.logOutputEncoding
5396 </dt>
5397 <dd>
5399 Encoding to use when displaying logs. (See <em>Discussion</em> above.)
5400 Defaults to the value of <code>i18n.commitEncoding</code> if set, and UTF-8
5401 otherwise.
5402 </p>
5403 </dd>
5404 </dl></div>
5405 <div class="paragraph"><p>Everything above this line in this section isn&#8217;t included from the
5406 <a href="git-config.html">git-config(1)</a> documentation. The content that follows is the
5407 same as what&#8217;s found there:</p></div>
5408 <div class="dlist"><dl>
5409 <dt class="hdlist1">
5410 log.abbrevCommit
5411 </dt>
5412 <dd>
5414 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
5415 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
5416 override this option with <code>--no-abbrev-commit</code>.
5417 </p>
5418 </dd>
5419 <dt class="hdlist1">
5420 log.date
5421 </dt>
5422 <dd>
5424 Set the default date-time mode for the <em>log</em> command.
5425 Setting a value for log.date is similar to using <em>git log</em>'s
5426 <code>--date</code> option. See <a href="git-log.html">git-log(1)</a> for details.
5427 </p>
5428 <div class="paragraph"><p>If the format is set to "auto:foo" and the pager is in use, format
5429 "foo" will be the used for the date format. Otherwise "default" will
5430 be used.</p></div>
5431 </dd>
5432 <dt class="hdlist1">
5433 log.decorate
5434 </dt>
5435 <dd>
5437 Print out the ref names of any commits that are shown by the log
5438 command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
5439 <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
5440 specified, the full ref name (including prefix) will be printed.
5441 If <em>auto</em> is specified, then if the output is going to a terminal,
5442 the ref names are shown as if <em>short</em> were given, otherwise no ref
5443 names are shown. This is the same as the <code>--decorate</code> option
5444 of the <code>git log</code>.
5445 </p>
5446 </dd>
5447 <dt class="hdlist1">
5448 log.initialDecorationSet
5449 </dt>
5450 <dd>
5452 By default, <code>git log</code> only shows decorations for certain known ref
5453 namespaces. If <em>all</em> is specified, then show all refs as
5454 decorations.
5455 </p>
5456 </dd>
5457 <dt class="hdlist1">
5458 log.excludeDecoration
5459 </dt>
5460 <dd>
5462 Exclude the specified patterns from the log decorations. This is
5463 similar to the <code>--decorate-refs-exclude</code> command-line option, but
5464 the config option can be overridden by the <code>--decorate-refs</code>
5465 option.
5466 </p>
5467 </dd>
5468 <dt class="hdlist1">
5469 log.diffMerges
5470 </dt>
5471 <dd>
5473 Set diff format to be used when <code>--diff-merges=on</code> is
5474 specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
5475 details. Defaults to <code>separate</code>.
5476 </p>
5477 </dd>
5478 <dt class="hdlist1">
5479 log.follow
5480 </dt>
5481 <dd>
5483 If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
5484 a single &lt;path&gt; is given. This has the same limitations as <code>--follow</code>,
5485 i.e. it cannot be used to follow multiple files and does not work well
5486 on non-linear history.
5487 </p>
5488 </dd>
5489 <dt class="hdlist1">
5490 log.graphColors
5491 </dt>
5492 <dd>
5494 A list of colors, separated by commas, that can be used to draw
5495 history lines in <code>git log --graph</code>.
5496 </p>
5497 </dd>
5498 <dt class="hdlist1">
5499 log.showRoot
5500 </dt>
5501 <dd>
5503 If true, the initial commit will be shown as a big creation event.
5504 This is equivalent to a diff against an empty tree.
5505 Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
5506 normally hide the root commit will now show it. True by default.
5507 </p>
5508 </dd>
5509 <dt class="hdlist1">
5510 log.showSignature
5511 </dt>
5512 <dd>
5514 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
5515 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.
5516 </p>
5517 </dd>
5518 <dt class="hdlist1">
5519 log.mailmap
5520 </dt>
5521 <dd>
5523 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
5524 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
5525 assume <code>--no-use-mailmap</code>. True by default.
5526 </p>
5527 </dd>
5528 <dt class="hdlist1">
5529 notes.mergeStrategy
5530 </dt>
5531 <dd>
5533 Which merge strategy to choose by default when resolving notes
5534 conflicts. Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
5535 <code>cat_sort_uniq</code>. Defaults to <code>manual</code>. See "NOTES MERGE STRATEGIES"
5536 section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
5537 </p>
5538 <div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
5539 <a href="git-notes.html">git-notes(1)</a>.</p></div>
5540 </dd>
5541 <dt class="hdlist1">
5542 notes.&lt;name&gt;.mergeStrategy
5543 </dt>
5544 <dd>
5546 Which merge strategy to choose when doing a notes merge into
5547 refs/notes/&lt;name&gt;. This overrides the more general
5548 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
5549 <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
5550 </p>
5551 </dd>
5552 <dt class="hdlist1">
5553 notes.displayRef
5554 </dt>
5555 <dd>
5557 Which ref (or refs, if a glob or specified more than once), in
5558 addition to the default set by <code>core.notesRef</code> or
5559 <code>GIT_NOTES_REF</code>, to read notes from when showing commit
5560 messages with the <em>git log</em> family of commands.
5561 </p>
5562 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
5563 environment variable, which must be a colon separated list of refs or
5564 globs.</p></div>
5565 <div class="paragraph"><p>A warning will be issued for refs that do not exist,
5566 but a glob that does not match any refs is silently ignored.</p></div>
5567 <div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
5568 log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
5569 those commands.</p></div>
5570 <div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
5571 GIT_NOTES_REF) is also implicitly added to the list of refs to be
5572 displayed.</p></div>
5573 </dd>
5574 <dt class="hdlist1">
5575 notes.rewrite.&lt;command&gt;
5576 </dt>
5577 <dd>
5579 When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
5580 <code>rebase</code>), if this variable is <code>false</code>, git will not copy
5581 notes from the original to the rewritten commit. Defaults to
5582 <code>true</code>. See also "<code>notes.rewriteRef</code>" below.
5583 </p>
5584 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
5585 environment variable, which must be a colon separated list of refs or
5586 globs.</p></div>
5587 </dd>
5588 <dt class="hdlist1">
5589 notes.rewriteMode
5590 </dt>
5591 <dd>
5593 When copying notes during a rewrite (see the
5594 "notes.rewrite.&lt;command&gt;" option), determines what to do if
5595 the target commit already has a note. Must be one of
5596 <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
5597 Defaults to <code>concatenate</code>.
5598 </p>
5599 <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
5600 environment variable.</p></div>
5601 </dd>
5602 <dt class="hdlist1">
5603 notes.rewriteRef
5604 </dt>
5605 <dd>
5607 When copying notes during a rewrite, specifies the (fully
5608 qualified) ref whose notes should be copied. May be a glob,
5609 in which case notes in all matching refs will be copied. You
5610 may also specify this configuration several times.
5611 </p>
5612 <div class="paragraph"><p>Does not have a default value; you must configure this variable to
5613 enable note rewriting. Set it to <code>refs/notes/commits</code> to enable
5614 rewriting for the default commit notes.</p></div>
5615 <div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
5616 See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p></div>
5617 </dd>
5618 </dl></div>
5619 </div>
5620 </div>
5621 <div class="sect1">
5622 <h2 id="_git">GIT</h2>
5623 <div class="sectionbody">
5624 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
5625 </div>
5626 </div>
5627 </div>
5628 <div id="footnotes"><hr /></div>
5629 <div id="footer">
5630 <div id="footer-text">
5631 Last updated
5632 2022-09-14 13:23:11 PDT
5633 </div>
5634 </div>
5635 </body>
5636 </html>