Autogenerated HTML docs for v2.42.0-45-g6807fc
[git-htmldocs.git] / git-show.html
blob53bd3b1d97778a1202b260fca70812bdf2af3c5d
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-show(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-show(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-show -
743 Show various types of objects
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 show</em> [&lt;options&gt;] [&lt;object&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 one or more objects (blobs, trees, tags and commits).</p></div>
761 <div class="paragraph"><p>For commits it shows the log message and textual diff. It also
762 presents the merge commit in a special format as produced by
763 <em>git diff-tree --cc</em>.</p></div>
764 <div class="paragraph"><p>For tags, it shows the tag message and the referenced objects.</p></div>
765 <div class="paragraph"><p>For trees, it shows the names (equivalent to <em>git ls-tree</em>
766 with --name-only).</p></div>
767 <div class="paragraph"><p>For plain blobs, it shows the plain contents.</p></div>
768 <div class="paragraph"><p>The command takes options applicable to the <em>git diff-tree</em> command to
769 control how the changes the commit introduces are shown.</p></div>
770 <div class="paragraph"><p>This manual page describes only the most frequently used options.</p></div>
771 </div>
772 </div>
773 <div class="sect1">
774 <h2 id="_options">OPTIONS</h2>
775 <div class="sectionbody">
776 <div class="dlist"><dl>
777 <dt class="hdlist1">
778 &lt;object&gt;&#8230;
779 </dt>
780 <dd>
782 The names of objects to show (defaults to <em>HEAD</em>).
783 For a more complete list of ways to spell object names, see
784 "SPECIFYING REVISIONS" section in <a href="gitrevisions.html">gitrevisions(7)</a>.
785 </p>
786 </dd>
787 <dt class="hdlist1">
788 --pretty[=&lt;format&gt;]
789 </dt>
790 <dt class="hdlist1">
791 --format=&lt;format&gt;
792 </dt>
793 <dd>
795 Pretty-print the contents of the commit logs in a given format,
796 where <em>&lt;format&gt;</em> can be one of <em>oneline</em>, <em>short</em>, <em>medium</em>,
797 <em>full</em>, <em>fuller</em>, <em>reference</em>, <em>email</em>, <em>raw</em>, <em>format:&lt;string&gt;</em>
798 and <em>tformat:&lt;string&gt;</em>. When <em>&lt;format&gt;</em> is none of the above,
799 and has <em>%placeholder</em> in it, it acts as if
800 <em>--pretty=tformat:&lt;format&gt;</em> were given.
801 </p>
802 <div class="paragraph"><p>See the "PRETTY FORMATS" section for some additional details for each
803 format. When <em>=&lt;format&gt;</em> part is omitted, it defaults to <em>medium</em>.</p></div>
804 <div class="paragraph"><p>Note: you can specify the default pretty format in the repository
805 configuration (see <a href="git-config.html">git-config(1)</a>).</p></div>
806 </dd>
807 <dt class="hdlist1">
808 --abbrev-commit
809 </dt>
810 <dd>
812 Instead of showing the full 40-byte hexadecimal commit object
813 name, show a prefix that names the object uniquely.
814 "--abbrev=&lt;n&gt;" (which also modifies diff output, if it is displayed)
815 option can be used to specify the minimum length of the prefix.
816 </p>
817 <div class="paragraph"><p>This should make "--pretty=oneline" a whole lot more readable for
818 people using 80-column terminals.</p></div>
819 </dd>
820 <dt class="hdlist1">
821 --no-abbrev-commit
822 </dt>
823 <dd>
825 Show the full 40-byte hexadecimal commit object name. This negates
826 <code>--abbrev-commit</code>, either explicit or implied by other options such
827 as "--oneline". It also overrides the <code>log.abbrevCommit</code> variable.
828 </p>
829 </dd>
830 <dt class="hdlist1">
831 --oneline
832 </dt>
833 <dd>
835 This is a shorthand for "--pretty=oneline --abbrev-commit"
836 used together.
837 </p>
838 </dd>
839 <dt class="hdlist1">
840 --encoding=&lt;encoding&gt;
841 </dt>
842 <dd>
844 Commit objects record the character encoding used for the log message
845 in their encoding header; this option can be used to tell the
846 command to re-code the commit log message in the encoding
847 preferred by the user. For non plumbing commands this
848 defaults to UTF-8. Note that if an object claims to be encoded
849 in <code>X</code> and we are outputting in <code>X</code>, we will output the object
850 verbatim; this means that invalid sequences in the original
851 commit may be copied to the output. Likewise, if iconv(3) fails
852 to convert the commit, we will quietly output the original
853 object verbatim.
854 </p>
855 </dd>
856 <dt class="hdlist1">
857 --expand-tabs=&lt;n&gt;
858 </dt>
859 <dt class="hdlist1">
860 --expand-tabs
861 </dt>
862 <dt class="hdlist1">
863 --no-expand-tabs
864 </dt>
865 <dd>
867 Perform a tab expansion (replace each tab with enough spaces
868 to fill to the next display column that is multiple of <em>&lt;n&gt;</em>)
869 in the log message before showing it in the output.
870 <code>--expand-tabs</code> is a short-hand for <code>--expand-tabs=8</code>, and
871 <code>--no-expand-tabs</code> is a short-hand for <code>--expand-tabs=0</code>,
872 which disables tab expansion.
873 </p>
874 <div class="paragraph"><p>By default, tabs are expanded in pretty formats that indent the log
875 message by 4 spaces (i.e. <em>medium</em>, which is the default, <em>full</em>,
876 and <em>fuller</em>).</p></div>
877 </dd>
878 <dt class="hdlist1">
879 --notes[=&lt;ref&gt;]
880 </dt>
881 <dd>
883 Show the notes (see <a href="git-notes.html">git-notes(1)</a>) that annotate the
884 commit, when showing the commit log message. This is the default
885 for <code>git log</code>, <code>git show</code> and <code>git whatchanged</code> commands when
886 there is no <code>--pretty</code>, <code>--format</code>, or <code>--oneline</code> option given
887 on the command line.
888 </p>
889 <div class="paragraph"><p>By default, the notes shown are from the notes refs listed in the
890 <code>core.notesRef</code> and <code>notes.displayRef</code> variables (or corresponding
891 environment overrides). See <a href="git-config.html">git-config(1)</a> for more details.</p></div>
892 <div class="paragraph"><p>With an optional <em>&lt;ref&gt;</em> argument, use the ref to find the notes
893 to display. The ref can specify the full refname when it begins
894 with <code>refs/notes/</code>; when it begins with <code>notes/</code>, <code>refs/</code> and otherwise
895 <code>refs/notes/</code> is prefixed to form a full name of the ref.</p></div>
896 <div class="paragraph"><p>Multiple --notes options can be combined to control which notes are
897 being displayed. Examples: "--notes=foo" will show only notes from
898 "refs/notes/foo"; "--notes=foo --notes" will show both notes from
899 "refs/notes/foo" and from the default notes ref(s).</p></div>
900 </dd>
901 <dt class="hdlist1">
902 --no-notes
903 </dt>
904 <dd>
906 Do not show notes. This negates the above <code>--notes</code> option, by
907 resetting the list of notes refs from which notes are shown.
908 Options are parsed in the order given on the command line, so e.g.
909 "--notes --notes=foo --no-notes --notes=bar" will only show notes
910 from "refs/notes/bar".
911 </p>
912 </dd>
913 <dt class="hdlist1">
914 --show-notes[=&lt;ref&gt;]
915 </dt>
916 <dt class="hdlist1">
917 --[no-]standard-notes
918 </dt>
919 <dd>
921 These options are deprecated. Use the above --notes/--no-notes
922 options instead.
923 </p>
924 </dd>
925 <dt class="hdlist1">
926 --show-signature
927 </dt>
928 <dd>
930 Check the validity of a signed commit object by passing the signature
931 to <code>gpg --verify</code> and show the output.
932 </p>
933 </dd>
934 </dl></div>
935 </div>
936 </div>
937 <div class="sect1">
938 <h2 id="_pretty_formats">PRETTY FORMATS</h2>
939 <div class="sectionbody">
940 <div class="paragraph"><p>If the commit is a merge, and if the pretty-format
941 is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is
942 inserted before the <em>Author:</em> line. This line begins with
943 "Merge: " and the hashes of ancestral commits are printed,
944 separated by spaces. Note that the listed commits may not
945 necessarily be the list of the <strong>direct</strong> parent commits if you
946 have limited your view of history: for example, if you are
947 only interested in changes related to a certain directory or
948 file.</p></div>
949 <div class="paragraph"><p>There are several built-in formats, and you can define
950 additional formats by setting a pretty.&lt;name&gt;
951 config option to either another format name, or a
952 <em>format:</em> string, as described below (see
953 <a href="git-config.html">git-config(1)</a>). Here are the details of the
954 built-in formats:</p></div>
955 <div class="ulist"><ul>
956 <li>
958 <em>oneline</em>
959 </p>
960 <div class="literalblock">
961 <div class="content">
962 <pre><code>&lt;hash&gt; &lt;title-line&gt;</code></pre>
963 </div></div>
964 <div class="paragraph"><p>This is designed to be as compact as possible.</p></div>
965 </li>
966 <li>
968 <em>short</em>
969 </p>
970 <div class="literalblock">
971 <div class="content">
972 <pre><code>commit &lt;hash&gt;
973 Author: &lt;author&gt;</code></pre>
974 </div></div>
975 <div class="literalblock">
976 <div class="content">
977 <pre><code>&lt;title-line&gt;</code></pre>
978 </div></div>
979 </li>
980 <li>
982 <em>medium</em>
983 </p>
984 <div class="literalblock">
985 <div class="content">
986 <pre><code>commit &lt;hash&gt;
987 Author: &lt;author&gt;
988 Date: &lt;author-date&gt;</code></pre>
989 </div></div>
990 <div class="literalblock">
991 <div class="content">
992 <pre><code>&lt;title-line&gt;</code></pre>
993 </div></div>
994 <div class="literalblock">
995 <div class="content">
996 <pre><code>&lt;full-commit-message&gt;</code></pre>
997 </div></div>
998 </li>
999 <li>
1001 <em>full</em>
1002 </p>
1003 <div class="literalblock">
1004 <div class="content">
1005 <pre><code>commit &lt;hash&gt;
1006 Author: &lt;author&gt;
1007 Commit: &lt;committer&gt;</code></pre>
1008 </div></div>
1009 <div class="literalblock">
1010 <div class="content">
1011 <pre><code>&lt;title-line&gt;</code></pre>
1012 </div></div>
1013 <div class="literalblock">
1014 <div class="content">
1015 <pre><code>&lt;full-commit-message&gt;</code></pre>
1016 </div></div>
1017 </li>
1018 <li>
1020 <em>fuller</em>
1021 </p>
1022 <div class="literalblock">
1023 <div class="content">
1024 <pre><code>commit &lt;hash&gt;
1025 Author: &lt;author&gt;
1026 AuthorDate: &lt;author-date&gt;
1027 Commit: &lt;committer&gt;
1028 CommitDate: &lt;committer-date&gt;</code></pre>
1029 </div></div>
1030 <div class="literalblock">
1031 <div class="content">
1032 <pre><code>&lt;title-line&gt;</code></pre>
1033 </div></div>
1034 <div class="literalblock">
1035 <div class="content">
1036 <pre><code>&lt;full-commit-message&gt;</code></pre>
1037 </div></div>
1038 </li>
1039 <li>
1041 <em>reference</em>
1042 </p>
1043 <div class="literalblock">
1044 <div class="content">
1045 <pre><code>&lt;abbrev-hash&gt; (&lt;title-line&gt;, &lt;short-author-date&gt;)</code></pre>
1046 </div></div>
1047 <div class="paragraph"><p>This format is used to refer to another commit in a commit message and
1048 is the same as <code>--pretty='format:%C(auto)%h (%s, %ad)'</code>. By default,
1049 the date is formatted with <code>--date=short</code> unless another <code>--date</code> option
1050 is explicitly specified. As with any <code>format:</code> with format
1051 placeholders, its output is not affected by other options like
1052 <code>--decorate</code> and <code>--walk-reflogs</code>.</p></div>
1053 </li>
1054 <li>
1056 <em>email</em>
1057 </p>
1058 <div class="literalblock">
1059 <div class="content">
1060 <pre><code>From &lt;hash&gt; &lt;date&gt;
1061 From: &lt;author&gt;
1062 Date: &lt;author-date&gt;
1063 Subject: [PATCH] &lt;title-line&gt;</code></pre>
1064 </div></div>
1065 <div class="literalblock">
1066 <div class="content">
1067 <pre><code>&lt;full-commit-message&gt;</code></pre>
1068 </div></div>
1069 </li>
1070 <li>
1072 <em>mboxrd</em>
1073 </p>
1074 <div class="paragraph"><p>Like <em>email</em>, but lines in the commit message starting with "From "
1075 (preceded by zero or more "&gt;") are quoted with "&gt;" so they aren&#8217;t
1076 confused as starting a new commit.</p></div>
1077 </li>
1078 <li>
1080 <em>raw</em>
1081 </p>
1082 <div class="paragraph"><p>The <em>raw</em> format shows the entire commit exactly as
1083 stored in the commit object. Notably, the hashes are
1084 displayed in full, regardless of whether --abbrev or
1085 --no-abbrev are used, and <em>parents</em> information show the
1086 true parent commits, without taking grafts or history
1087 simplification into account. Note that this format affects the way
1088 commits are displayed, but not the way the diff is shown e.g. with
1089 <code>git log --raw</code>. To get full object names in a raw diff format,
1090 use <code>--no-abbrev</code>.</p></div>
1091 </li>
1092 <li>
1094 <em>format:&lt;format-string&gt;</em>
1095 </p>
1096 <div class="paragraph"><p>The <em>format:&lt;format-string&gt;</em> format allows you to specify which information
1097 you want to show. It works a little bit like printf format,
1098 with the notable exception that you get a newline with <em>%n</em>
1099 instead of <em>\n</em>.</p></div>
1100 <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>
1101 would show something like this:</p></div>
1102 <div class="listingblock">
1103 <div class="content">
1104 <pre><code>The author of fe6e0ee was Junio C Hamano, 23 hours ago
1105 The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;</code></pre>
1106 </div></div>
1107 <div class="paragraph"><p>The placeholders are:</p></div>
1108 <div class="ulist"><ul>
1109 <li>
1111 Placeholders that expand to a single literal character:
1112 </p>
1113 <div class="dlist"><dl>
1114 <dt class="hdlist1">
1115 <em>%n</em>
1116 </dt>
1117 <dd>
1119 newline
1120 </p>
1121 </dd>
1122 <dt class="hdlist1">
1123 <em>%%</em>
1124 </dt>
1125 <dd>
1127 a raw <em>%</em>
1128 </p>
1129 </dd>
1130 <dt class="hdlist1">
1131 <em>%x00</em>
1132 </dt>
1133 <dd>
1135 print a byte from a hex code
1136 </p>
1137 </dd>
1138 </dl></div>
1139 </li>
1140 <li>
1142 Placeholders that affect formatting of later placeholders:
1143 </p>
1144 <div class="dlist"><dl>
1145 <dt class="hdlist1">
1146 <em>%Cred</em>
1147 </dt>
1148 <dd>
1150 switch color to red
1151 </p>
1152 </dd>
1153 <dt class="hdlist1">
1154 <em>%Cgreen</em>
1155 </dt>
1156 <dd>
1158 switch color to green
1159 </p>
1160 </dd>
1161 <dt class="hdlist1">
1162 <em>%Cblue</em>
1163 </dt>
1164 <dd>
1166 switch color to blue
1167 </p>
1168 </dd>
1169 <dt class="hdlist1">
1170 <em>%Creset</em>
1171 </dt>
1172 <dd>
1174 reset color
1175 </p>
1176 </dd>
1177 <dt class="hdlist1">
1178 <em>%C(&#8230;)</em>
1179 </dt>
1180 <dd>
1182 color specification, as described under Values in the
1183 "CONFIGURATION FILE" section of <a href="git-config.html">git-config(1)</a>. By
1184 default, colors are shown only when enabled for log output
1185 (by <code>color.diff</code>, <code>color.ui</code>, or <code>--color</code>, and respecting
1186 the <code>auto</code> settings of the former if we are going to a
1187 terminal). <code>%C(auto,...)</code> is accepted as a historical
1188 synonym for the default (e.g., <code>%C(auto,red)</code>). Specifying
1189 <code>%C(always,...)</code> will show the colors even when color is
1190 not otherwise enabled (though consider just using
1191 <code>--color=always</code> to enable color for the whole output,
1192 including this format and anything else git might color).
1193 <code>auto</code> alone (i.e. <code>%C(auto)</code>) will turn on auto coloring
1194 on the next placeholders until the color is switched
1195 again.
1196 </p>
1197 </dd>
1198 <dt class="hdlist1">
1199 <em>%m</em>
1200 </dt>
1201 <dd>
1203 left (<code>&lt;</code>), right (<code>&gt;</code>) or boundary (<code>-</code>) mark
1204 </p>
1205 </dd>
1206 <dt class="hdlist1">
1207 <em>%w([&lt;w&gt;[,&lt;i1&gt;[,&lt;i2&gt;]]])</em>
1208 </dt>
1209 <dd>
1211 switch line wrapping, like the -w option of
1212 <a href="git-shortlog.html">git-shortlog(1)</a>.
1213 </p>
1214 </dd>
1215 <dt class="hdlist1">
1216 <em>%&lt;( &lt;N&gt; [,trunc|ltrunc|mtrunc])</em>
1217 </dt>
1218 <dd>
1220 make the next placeholder take at
1221 least N column widths, padding spaces on
1222 the right if necessary. Optionally
1223 truncate (with ellipsis <em>..</em>) at the left (ltrunc) <code>..ft</code>,
1224 the middle (mtrunc) <code>mi..le</code>, or the end
1225 (trunc) <code>rig..</code>, if the output is longer than
1226 N columns.
1227 Note 1: that truncating
1228 only works correctly with N &gt;= 2.
1229 Note 2: spaces around the N and M (see below)
1230 values are optional.
1231 Note 3: Emojis and other wide characters
1232 will take two display columns, which may
1233 over-run column boundaries.
1234 Note 4: decomposed character combining marks
1235 may be misplaced at padding boundaries.
1236 </p>
1237 </dd>
1238 <dt class="hdlist1">
1239 <em>%&lt;|( &lt;M&gt; )</em>
1240 </dt>
1241 <dd>
1243 make the next placeholder take at least until Mth
1244 display column, padding spaces on the right if necessary.
1245 Use negative M values for column positions measured
1246 from the right hand edge of the terminal window.
1247 </p>
1248 </dd>
1249 <dt class="hdlist1">
1250 <em>%&gt;( &lt;N&gt; )</em>, <em>%&gt;|( &lt;M&gt; )</em>
1251 </dt>
1252 <dd>
1254 similar to <em>%&lt;( &lt;N&gt; )</em>, <em>%&lt;|( &lt;M&gt; )</em> respectively,
1255 but padding spaces on the left
1256 </p>
1257 </dd>
1258 <dt class="hdlist1">
1259 <em>%&gt;&gt;( &lt;N&gt; )</em>, <em>%&gt;&gt;|( &lt;M&gt; )</em>
1260 </dt>
1261 <dd>
1263 similar to <em>%&gt;( &lt;N&gt; )</em>, <em>%&gt;|( &lt;M&gt; )</em>
1264 respectively, except that if the next
1265 placeholder takes more spaces than given and
1266 there are spaces on its left, use those
1267 spaces
1268 </p>
1269 </dd>
1270 <dt class="hdlist1">
1271 <em>%&gt;&lt;( &lt;N&gt; )</em>, <em>%&gt;&lt;|( &lt;M&gt; )</em>
1272 </dt>
1273 <dd>
1275 similar to <em>%&lt;( &lt;N&gt; )</em>, <em>%&lt;|( &lt;M&gt; )</em>
1276 respectively, but padding both sides
1277 (i.e. the text is centered)
1278 </p>
1279 </dd>
1280 </dl></div>
1281 </li>
1282 <li>
1284 Placeholders that expand to information extracted from the commit:
1285 </p>
1286 <div class="dlist"><dl>
1287 <dt class="hdlist1">
1288 <em>%H</em>
1289 </dt>
1290 <dd>
1292 commit hash
1293 </p>
1294 </dd>
1295 <dt class="hdlist1">
1296 <em>%h</em>
1297 </dt>
1298 <dd>
1300 abbreviated commit hash
1301 </p>
1302 </dd>
1303 <dt class="hdlist1">
1304 <em>%T</em>
1305 </dt>
1306 <dd>
1308 tree hash
1309 </p>
1310 </dd>
1311 <dt class="hdlist1">
1312 <em>%t</em>
1313 </dt>
1314 <dd>
1316 abbreviated tree hash
1317 </p>
1318 </dd>
1319 <dt class="hdlist1">
1320 <em>%P</em>
1321 </dt>
1322 <dd>
1324 parent hashes
1325 </p>
1326 </dd>
1327 <dt class="hdlist1">
1328 <em>%p</em>
1329 </dt>
1330 <dd>
1332 abbreviated parent hashes
1333 </p>
1334 </dd>
1335 <dt class="hdlist1">
1336 <em>%an</em>
1337 </dt>
1338 <dd>
1340 author name
1341 </p>
1342 </dd>
1343 <dt class="hdlist1">
1344 <em>%aN</em>
1345 </dt>
1346 <dd>
1348 author name (respecting .mailmap, see <a href="git-shortlog.html">git-shortlog(1)</a>
1349 or <a href="git-blame.html">git-blame(1)</a>)
1350 </p>
1351 </dd>
1352 <dt class="hdlist1">
1353 <em>%ae</em>
1354 </dt>
1355 <dd>
1357 author email
1358 </p>
1359 </dd>
1360 <dt class="hdlist1">
1361 <em>%aE</em>
1362 </dt>
1363 <dd>
1365 author email (respecting .mailmap, see <a href="git-shortlog.html">git-shortlog(1)</a>
1366 or <a href="git-blame.html">git-blame(1)</a>)
1367 </p>
1368 </dd>
1369 <dt class="hdlist1">
1370 <em>%al</em>
1371 </dt>
1372 <dd>
1374 author email local-part (the part before the <em>@</em> sign)
1375 </p>
1376 </dd>
1377 <dt class="hdlist1">
1378 <em>%aL</em>
1379 </dt>
1380 <dd>
1382 author local-part (see <em>%al</em>) respecting .mailmap, see
1383 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
1384 </p>
1385 </dd>
1386 <dt class="hdlist1">
1387 <em>%ad</em>
1388 </dt>
1389 <dd>
1391 author date (format respects --date= option)
1392 </p>
1393 </dd>
1394 <dt class="hdlist1">
1395 <em>%aD</em>
1396 </dt>
1397 <dd>
1399 author date, RFC2822 style
1400 </p>
1401 </dd>
1402 <dt class="hdlist1">
1403 <em>%ar</em>
1404 </dt>
1405 <dd>
1407 author date, relative
1408 </p>
1409 </dd>
1410 <dt class="hdlist1">
1411 <em>%at</em>
1412 </dt>
1413 <dd>
1415 author date, UNIX timestamp
1416 </p>
1417 </dd>
1418 <dt class="hdlist1">
1419 <em>%ai</em>
1420 </dt>
1421 <dd>
1423 author date, ISO 8601-like format
1424 </p>
1425 </dd>
1426 <dt class="hdlist1">
1427 <em>%aI</em>
1428 </dt>
1429 <dd>
1431 author date, strict ISO 8601 format
1432 </p>
1433 </dd>
1434 <dt class="hdlist1">
1435 <em>%as</em>
1436 </dt>
1437 <dd>
1439 author date, short format (<code>YYYY-MM-DD</code>)
1440 </p>
1441 </dd>
1442 <dt class="hdlist1">
1443 <em>%ah</em>
1444 </dt>
1445 <dd>
1447 author date, human style (like the <code>--date=human</code> option of
1448 <a href="git-rev-list.html">git-rev-list(1)</a>)
1449 </p>
1450 </dd>
1451 <dt class="hdlist1">
1452 <em>%cn</em>
1453 </dt>
1454 <dd>
1456 committer name
1457 </p>
1458 </dd>
1459 <dt class="hdlist1">
1460 <em>%cN</em>
1461 </dt>
1462 <dd>
1464 committer name (respecting .mailmap, see
1465 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
1466 </p>
1467 </dd>
1468 <dt class="hdlist1">
1469 <em>%ce</em>
1470 </dt>
1471 <dd>
1473 committer email
1474 </p>
1475 </dd>
1476 <dt class="hdlist1">
1477 <em>%cE</em>
1478 </dt>
1479 <dd>
1481 committer email (respecting .mailmap, see
1482 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
1483 </p>
1484 </dd>
1485 <dt class="hdlist1">
1486 <em>%cl</em>
1487 </dt>
1488 <dd>
1490 committer email local-part (the part before the <em>@</em> sign)
1491 </p>
1492 </dd>
1493 <dt class="hdlist1">
1494 <em>%cL</em>
1495 </dt>
1496 <dd>
1498 committer local-part (see <em>%cl</em>) respecting .mailmap, see
1499 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
1500 </p>
1501 </dd>
1502 <dt class="hdlist1">
1503 <em>%cd</em>
1504 </dt>
1505 <dd>
1507 committer date (format respects --date= option)
1508 </p>
1509 </dd>
1510 <dt class="hdlist1">
1511 <em>%cD</em>
1512 </dt>
1513 <dd>
1515 committer date, RFC2822 style
1516 </p>
1517 </dd>
1518 <dt class="hdlist1">
1519 <em>%cr</em>
1520 </dt>
1521 <dd>
1523 committer date, relative
1524 </p>
1525 </dd>
1526 <dt class="hdlist1">
1527 <em>%ct</em>
1528 </dt>
1529 <dd>
1531 committer date, UNIX timestamp
1532 </p>
1533 </dd>
1534 <dt class="hdlist1">
1535 <em>%ci</em>
1536 </dt>
1537 <dd>
1539 committer date, ISO 8601-like format
1540 </p>
1541 </dd>
1542 <dt class="hdlist1">
1543 <em>%cI</em>
1544 </dt>
1545 <dd>
1547 committer date, strict ISO 8601 format
1548 </p>
1549 </dd>
1550 <dt class="hdlist1">
1551 <em>%cs</em>
1552 </dt>
1553 <dd>
1555 committer date, short format (<code>YYYY-MM-DD</code>)
1556 </p>
1557 </dd>
1558 <dt class="hdlist1">
1559 <em>%ch</em>
1560 </dt>
1561 <dd>
1563 committer date, human style (like the <code>--date=human</code> option of
1564 <a href="git-rev-list.html">git-rev-list(1)</a>)
1565 </p>
1566 </dd>
1567 <dt class="hdlist1">
1568 <em>%d</em>
1569 </dt>
1570 <dd>
1572 ref names, like the --decorate option of <a href="git-log.html">git-log(1)</a>
1573 </p>
1574 </dd>
1575 <dt class="hdlist1">
1576 <em>%D</em>
1577 </dt>
1578 <dd>
1580 ref names without the " (", ")" wrapping.
1581 </p>
1582 </dd>
1583 <dt class="hdlist1">
1584 <em>%(describe[:options])</em>
1585 </dt>
1586 <dd>
1588 human-readable name, like
1589 <a href="git-describe.html">git-describe(1)</a>; empty string for
1590 undescribable commits. The <code>describe</code> string
1591 may be followed by a colon and zero or more
1592 comma-separated options. Descriptions can be
1593 inconsistent when tags are added or removed at
1594 the same time.
1595 </p>
1596 <div class="ulist"><ul>
1597 <li>
1599 <em>tags[=&lt;bool-value&gt;]</em>: Instead of only considering annotated tags,
1600 consider lightweight tags as well.
1601 </p>
1602 </li>
1603 <li>
1605 <em>abbrev=&lt;number&gt;</em>: Instead of using the default number of hexadecimal digits
1606 (which will vary according to the number of objects in the repository with a
1607 default of 7) of the abbreviated object name, use &lt;number&gt; digits, or as many
1608 digits as needed to form a unique object name.
1609 </p>
1610 </li>
1611 <li>
1613 <em>match=&lt;pattern&gt;</em>: Only consider tags matching the given
1614 <code>glob(7)</code> pattern, excluding the "refs/tags/" prefix.
1615 </p>
1616 </li>
1617 <li>
1619 <em>exclude=&lt;pattern&gt;</em>: Do not consider tags matching the given
1620 <code>glob(7)</code> pattern, excluding the "refs/tags/" prefix.
1621 </p>
1622 </li>
1623 </ul></div>
1624 </dd>
1625 <dt class="hdlist1">
1626 <em>%S</em>
1627 </dt>
1628 <dd>
1630 ref name given on the command line by which the commit was reached
1631 (like <code>git log --source</code>), only works with <code>git log</code>
1632 </p>
1633 </dd>
1634 <dt class="hdlist1">
1635 <em>%e</em>
1636 </dt>
1637 <dd>
1639 encoding
1640 </p>
1641 </dd>
1642 <dt class="hdlist1">
1643 <em>%s</em>
1644 </dt>
1645 <dd>
1647 subject
1648 </p>
1649 </dd>
1650 <dt class="hdlist1">
1651 <em>%f</em>
1652 </dt>
1653 <dd>
1655 sanitized subject line, suitable for a filename
1656 </p>
1657 </dd>
1658 <dt class="hdlist1">
1659 <em>%b</em>
1660 </dt>
1661 <dd>
1663 body
1664 </p>
1665 </dd>
1666 <dt class="hdlist1">
1667 <em>%B</em>
1668 </dt>
1669 <dd>
1671 raw body (unwrapped subject and body)
1672 </p>
1673 </dd>
1674 <dt class="hdlist1">
1675 <em>%N</em>
1676 </dt>
1677 <dd>
1679 commit notes
1680 </p>
1681 </dd>
1682 <dt class="hdlist1">
1683 <em>%GG</em>
1684 </dt>
1685 <dd>
1687 raw verification message from GPG for a signed commit
1688 </p>
1689 </dd>
1690 <dt class="hdlist1">
1691 <em>%G?</em>
1692 </dt>
1693 <dd>
1695 show "G" for a good (valid) signature,
1696 "B" for a bad signature,
1697 "U" for a good signature with unknown validity,
1698 "X" for a good signature that has expired,
1699 "Y" for a good signature made by an expired key,
1700 "R" for a good signature made by a revoked key,
1701 "E" if the signature cannot be checked (e.g. missing key)
1702 and "N" for no signature
1703 </p>
1704 </dd>
1705 <dt class="hdlist1">
1706 <em>%GS</em>
1707 </dt>
1708 <dd>
1710 show the name of the signer for a signed commit
1711 </p>
1712 </dd>
1713 <dt class="hdlist1">
1714 <em>%GK</em>
1715 </dt>
1716 <dd>
1718 show the key used to sign a signed commit
1719 </p>
1720 </dd>
1721 <dt class="hdlist1">
1722 <em>%GF</em>
1723 </dt>
1724 <dd>
1726 show the fingerprint of the key used to sign a signed commit
1727 </p>
1728 </dd>
1729 <dt class="hdlist1">
1730 <em>%GP</em>
1731 </dt>
1732 <dd>
1734 show the fingerprint of the primary key whose subkey was used
1735 to sign a signed commit
1736 </p>
1737 </dd>
1738 <dt class="hdlist1">
1739 <em>%GT</em>
1740 </dt>
1741 <dd>
1743 show the trust level for the key used to sign a signed commit
1744 </p>
1745 </dd>
1746 <dt class="hdlist1">
1747 <em>%gD</em>
1748 </dt>
1749 <dd>
1751 reflog selector, e.g., <code>refs/stash@{1}</code> or <code>refs/stash@{2
1752 minutes ago}</code>; the format follows the rules described for the
1753 <code>-g</code> option. The portion before the <code>@</code> is the refname as
1754 given on the command line (so <code>git log -g refs/heads/master</code>
1755 would yield <code>refs/heads/master@{0}</code>).
1756 </p>
1757 </dd>
1758 <dt class="hdlist1">
1759 <em>%gd</em>
1760 </dt>
1761 <dd>
1763 shortened reflog selector; same as <code>%gD</code>, but the refname
1764 portion is shortened for human readability (so
1765 <code>refs/heads/master</code> becomes just <code>master</code>).
1766 </p>
1767 </dd>
1768 <dt class="hdlist1">
1769 <em>%gn</em>
1770 </dt>
1771 <dd>
1773 reflog identity name
1774 </p>
1775 </dd>
1776 <dt class="hdlist1">
1777 <em>%gN</em>
1778 </dt>
1779 <dd>
1781 reflog identity name (respecting .mailmap, see
1782 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
1783 </p>
1784 </dd>
1785 <dt class="hdlist1">
1786 <em>%ge</em>
1787 </dt>
1788 <dd>
1790 reflog identity email
1791 </p>
1792 </dd>
1793 <dt class="hdlist1">
1794 <em>%gE</em>
1795 </dt>
1796 <dd>
1798 reflog identity email (respecting .mailmap, see
1799 <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
1800 </p>
1801 </dd>
1802 <dt class="hdlist1">
1803 <em>%gs</em>
1804 </dt>
1805 <dd>
1807 reflog subject
1808 </p>
1809 </dd>
1810 <dt class="hdlist1">
1811 <em>%(trailers[:options])</em>
1812 </dt>
1813 <dd>
1815 display the trailers of the body as
1816 interpreted by
1817 <a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>. The
1818 <code>trailers</code> string may be followed by a colon
1819 and zero or more comma-separated options.
1820 If any option is provided multiple times the
1821 last occurrence wins.
1822 </p>
1823 <div class="ulist"><ul>
1824 <li>
1826 <em>key=&lt;key&gt;</em>: only show trailers with specified &lt;key&gt;. Matching is done
1827 case-insensitively and trailing colon is optional. If option is
1828 given multiple times trailer lines matching any of the keys are
1829 shown. This option automatically enables the <code>only</code> option so that
1830 non-trailer lines in the trailer block are hidden. If that is not
1831 desired it can be disabled with <code>only=false</code>. E.g.,
1832 <code>%(trailers:key=Reviewed-by)</code> shows trailer lines with key
1833 <code>Reviewed-by</code>.
1834 </p>
1835 </li>
1836 <li>
1838 <em>only[=&lt;bool&gt;]</em>: select whether non-trailer lines from the trailer
1839 block should be included.
1840 </p>
1841 </li>
1842 <li>
1844 <em>separator=&lt;sep&gt;</em>: specify a separator inserted between trailer
1845 lines. When this option is not given each trailer line is
1846 terminated with a line feed character. The string &lt;sep&gt; may contain
1847 the literal formatting codes described above. To use comma as
1848 separator one must use <code>%x2C</code> as it would otherwise be parsed as
1849 next option. E.g., <code>%(trailers:key=Ticket,separator=%x2C )</code>
1850 shows all trailer lines whose key is "Ticket" separated by a comma
1851 and a space.
1852 </p>
1853 </li>
1854 <li>
1856 <em>unfold[=&lt;bool&gt;]</em>: make it behave as if interpret-trailer&#8217;s <code>--unfold</code>
1857 option was given. E.g.,
1858 <code>%(trailers:only,unfold=true)</code> unfolds and shows all trailer lines.
1859 </p>
1860 </li>
1861 <li>
1863 <em>keyonly[=&lt;bool&gt;]</em>: only show the key part of the trailer.
1864 </p>
1865 </li>
1866 <li>
1868 <em>valueonly[=&lt;bool&gt;]</em>: only show the value part of the trailer.
1869 </p>
1870 </li>
1871 <li>
1873 <em>key_value_separator=&lt;sep&gt;</em>: specify a separator inserted between
1874 trailer lines. When this option is not given each trailer key-value
1875 pair is separated by ": ". Otherwise it shares the same semantics
1876 as <em>separator=&lt;sep&gt;</em> above.
1877 </p>
1878 </li>
1879 </ul></div>
1880 </dd>
1881 </dl></div>
1882 </li>
1883 </ul></div>
1884 </li>
1885 </ul></div>
1886 <div class="admonitionblock">
1887 <table><tr>
1888 <td class="icon">
1889 <div class="title">Note</div>
1890 </td>
1891 <td class="content">Some placeholders may depend on other options given to the
1892 revision traversal engine. For example, the <code>%g*</code> reflog options will
1893 insert an empty string unless we are traversing reflog entries (e.g., by
1894 <code>git log -g</code>). The <code>%d</code> and <code>%D</code> placeholders will use the "short"
1895 decoration format if <code>--decorate</code> was not already provided on the command
1896 line.</td>
1897 </tr></table>
1898 </div>
1899 <div class="paragraph"><p>The boolean options accept an optional value <code>[=&lt;bool-value&gt;]</code>. The values
1900 <code>true</code>, <code>false</code>, <code>on</code>, <code>off</code> etc. are all accepted. See the "boolean"
1901 sub-section in "EXAMPLES" in <a href="git-config.html">git-config(1)</a>. If a boolean
1902 option is given with no value, it&#8217;s enabled.</p></div>
1903 <div class="paragraph"><p>If you add a <code>+</code> (plus sign) after <em>%</em> of a placeholder, a line-feed
1904 is inserted immediately before the expansion if and only if the
1905 placeholder expands to a non-empty string.</p></div>
1906 <div class="paragraph"><p>If you add a <code>-</code> (minus sign) after <em>%</em> of a placeholder, all consecutive
1907 line-feeds immediately preceding the expansion are deleted if and only if the
1908 placeholder expands to an empty string.</p></div>
1909 <div class="paragraph"><p>If you add a ` ` (space) after <em>%</em> of a placeholder, a space
1910 is inserted immediately before the expansion if and only if the
1911 placeholder expands to a non-empty string.</p></div>
1912 <div class="ulist"><ul>
1913 <li>
1915 <em>tformat:</em>
1916 </p>
1917 <div class="paragraph"><p>The <em>tformat:</em> format works exactly like <em>format:</em>, except that it
1918 provides "terminator" semantics instead of "separator" semantics. In
1919 other words, each commit has the message terminator character (usually a
1920 newline) appended, rather than a separator placed between entries.
1921 This means that the final entry of a single-line format will be properly
1922 terminated with a new line, just as the "oneline" format does.
1923 For example:</p></div>
1924 <div class="listingblock">
1925 <div class="content">
1926 <pre><code>$ git log -2 --pretty=format:%h 4da45bef \
1927 | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
1928 4da45be
1929 7134973 -- NO NEWLINE
1931 $ git log -2 --pretty=tformat:%h 4da45bef \
1932 | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
1933 4da45be
1934 7134973</code></pre>
1935 </div></div>
1936 <div class="paragraph"><p>In addition, any unrecognized string that has a <code>%</code> in it is interpreted
1937 as if it has <code>tformat:</code> in front of it. For example, these two are
1938 equivalent:</p></div>
1939 <div class="listingblock">
1940 <div class="content">
1941 <pre><code>$ git log -2 --pretty=tformat:%h 4da45bef
1942 $ git log -2 --pretty=%h 4da45bef</code></pre>
1943 </div></div>
1944 </li>
1945 </ul></div>
1946 </div>
1947 </div>
1948 <div class="sect1">
1949 <h2 id="_diff_formatting">DIFF FORMATTING</h2>
1950 <div class="sectionbody">
1951 <div class="paragraph"><p>The options below can be used to change the way <code>git show</code> generates
1952 diff output.</p></div>
1953 <div class="dlist"><dl>
1954 <dt class="hdlist1">
1956 </dt>
1957 <dt class="hdlist1">
1959 </dt>
1960 <dt class="hdlist1">
1961 --patch
1962 </dt>
1963 <dd>
1965 Generate patch (see section titled
1966 <a href="#generate_patch_text_with_p">"Generating patch text with -p"</a>).
1967 </p>
1968 </dd>
1969 <dt class="hdlist1">
1971 </dt>
1972 <dt class="hdlist1">
1973 --no-patch
1974 </dt>
1975 <dd>
1977 Suppress all output from the diff machinery. Useful for
1978 commands like <code>git show</code> that show the patch by default to
1979 squelch their output, or to cancel the effect of options like
1980 <code>--patch</code>, <code>--stat</code> earlier on the command line in an alias.
1981 </p>
1982 </dd>
1983 <dt class="hdlist1">
1984 --diff-merges=(off|none|on|first-parent|1|separate|m|combined|c|dense-combined|cc|remerge|r)
1985 </dt>
1986 <dt class="hdlist1">
1987 --no-diff-merges
1988 </dt>
1989 <dd>
1991 Specify diff format to be used for merge commits. Default is
1992 <code>dense-combined</code> unless <code>--first-parent</code> is in use, in which case
1993 <code>first-parent</code> is the default.
1994 </p>
1995 <div class="dlist"><dl>
1996 <dt class="hdlist1">
1997 --diff-merges=(off|none)
1998 </dt>
1999 <dt class="hdlist1">
2000 --no-diff-merges
2001 </dt>
2002 <dd>
2004 Disable output of diffs for merge commits. Useful to override
2005 implied value.
2006 </p>
2007 </dd>
2008 <dt class="hdlist1">
2009 --diff-merges=on
2010 </dt>
2011 <dt class="hdlist1">
2012 --diff-merges=m
2013 </dt>
2014 <dt class="hdlist1">
2016 </dt>
2017 <dd>
2019 This option makes diff output for merge commits to be shown in
2020 the default format. <code>-m</code> will produce the output only if <code>-p</code>
2021 is given as well. The default format could be changed using
2022 <code>log.diffMerges</code> configuration parameter, which default value
2023 is <code>separate</code>.
2024 </p>
2025 </dd>
2026 <dt class="hdlist1">
2027 --diff-merges=first-parent
2028 </dt>
2029 <dt class="hdlist1">
2030 --diff-merges=1
2031 </dt>
2032 <dd>
2034 This option makes merge commits show the full diff with
2035 respect to the first parent only.
2036 </p>
2037 </dd>
2038 <dt class="hdlist1">
2039 --diff-merges=separate
2040 </dt>
2041 <dd>
2043 This makes merge commits show the full diff with respect to
2044 each of the parents. Separate log entry and diff is generated
2045 for each parent.
2046 </p>
2047 </dd>
2048 <dt class="hdlist1">
2049 --diff-merges=remerge
2050 </dt>
2051 <dt class="hdlist1">
2052 --diff-merges=r
2053 </dt>
2054 <dt class="hdlist1">
2055 --remerge-diff
2056 </dt>
2057 <dd>
2059 With this option, two-parent merge commits are remerged to
2060 create a temporary tree object&#8201;&#8212;&#8201;potentially containing files
2061 with conflict markers and such. A diff is then shown between
2062 that temporary tree and the actual merge commit.
2063 </p>
2064 <div class="paragraph"><p>The output emitted when this option is used is subject to change, and
2065 so is its interaction with other options (unless explicitly
2066 documented).</p></div>
2067 </dd>
2068 <dt class="hdlist1">
2069 --diff-merges=combined
2070 </dt>
2071 <dt class="hdlist1">
2072 --diff-merges=c
2073 </dt>
2074 <dt class="hdlist1">
2076 </dt>
2077 <dd>
2079 With this option, diff output for a merge commit shows the
2080 differences from each of the parents to the merge result
2081 simultaneously instead of showing pairwise diff between a
2082 parent and the result one at a time. Furthermore, it lists
2083 only files which were modified from all parents. <code>-c</code> implies
2084 <code>-p</code>.
2085 </p>
2086 </dd>
2087 <dt class="hdlist1">
2088 --diff-merges=dense-combined
2089 </dt>
2090 <dt class="hdlist1">
2091 --diff-merges=cc
2092 </dt>
2093 <dt class="hdlist1">
2094 --cc
2095 </dt>
2096 <dd>
2098 With this option the output produced by
2099 <code>--diff-merges=combined</code> is further compressed by omitting
2100 uninteresting hunks whose contents in the parents have only
2101 two variants and the merge result picks one of them without
2102 modification. <code>--cc</code> implies <code>-p</code>.
2103 </p>
2104 </dd>
2105 </dl></div>
2106 </dd>
2107 <dt class="hdlist1">
2108 --combined-all-paths
2109 </dt>
2110 <dd>
2112 This flag causes combined diffs (used for merge commits) to
2113 list the name of the file from all parents. It thus only has
2114 effect when <code>--diff-merges=[dense-]combined</code> is in use, and
2115 is likely only useful if filename changes are detected (i.e.
2116 when either rename or copy detection have been requested).
2117 </p>
2118 </dd>
2119 <dt class="hdlist1">
2120 -U&lt;n&gt;
2121 </dt>
2122 <dt class="hdlist1">
2123 --unified=&lt;n&gt;
2124 </dt>
2125 <dd>
2127 Generate diffs with &lt;n&gt; lines of context instead of
2128 the usual three.
2129 Implies <code>--patch</code>.
2130 </p>
2131 </dd>
2132 <dt class="hdlist1">
2133 --output=&lt;file&gt;
2134 </dt>
2135 <dd>
2137 Output to a specific file instead of stdout.
2138 </p>
2139 </dd>
2140 <dt class="hdlist1">
2141 --output-indicator-new=&lt;char&gt;
2142 </dt>
2143 <dt class="hdlist1">
2144 --output-indicator-old=&lt;char&gt;
2145 </dt>
2146 <dt class="hdlist1">
2147 --output-indicator-context=&lt;char&gt;
2148 </dt>
2149 <dd>
2151 Specify the character used to indicate new, old or context
2152 lines in the generated patch. Normally they are <em>+</em>, <em>-</em> and
2153 ' ' respectively.
2154 </p>
2155 </dd>
2156 <dt class="hdlist1">
2157 --raw
2158 </dt>
2159 <dd>
2161 For each commit, show a summary of changes using the raw diff
2162 format. See the "RAW OUTPUT FORMAT" section of
2163 <a href="git-diff.html">git-diff(1)</a>. This is different from showing the log
2164 itself in raw format, which you can achieve with
2165 <code>--format=raw</code>.
2166 </p>
2167 </dd>
2168 <dt class="hdlist1">
2169 --patch-with-raw
2170 </dt>
2171 <dd>
2173 Synonym for <code>-p --raw</code>.
2174 </p>
2175 </dd>
2176 <dt class="hdlist1">
2178 </dt>
2179 <dd>
2181 Show the tree objects in the diff output.
2182 </p>
2183 </dd>
2184 <dt class="hdlist1">
2185 --indent-heuristic
2186 </dt>
2187 <dd>
2189 Enable the heuristic that shifts diff hunk boundaries to make patches
2190 easier to read. This is the default.
2191 </p>
2192 </dd>
2193 <dt class="hdlist1">
2194 --no-indent-heuristic
2195 </dt>
2196 <dd>
2198 Disable the indent heuristic.
2199 </p>
2200 </dd>
2201 <dt class="hdlist1">
2202 --minimal
2203 </dt>
2204 <dd>
2206 Spend extra time to make sure the smallest possible
2207 diff is produced.
2208 </p>
2209 </dd>
2210 <dt class="hdlist1">
2211 --patience
2212 </dt>
2213 <dd>
2215 Generate a diff using the "patience diff" algorithm.
2216 </p>
2217 </dd>
2218 <dt class="hdlist1">
2219 --histogram
2220 </dt>
2221 <dd>
2223 Generate a diff using the "histogram diff" algorithm.
2224 </p>
2225 </dd>
2226 <dt class="hdlist1">
2227 --anchored=&lt;text&gt;
2228 </dt>
2229 <dd>
2231 Generate a diff using the "anchored diff" algorithm.
2232 </p>
2233 <div class="paragraph"><p>This option may be specified more than once.</p></div>
2234 <div class="paragraph"><p>If a line exists in both the source and destination, exists only once,
2235 and starts with this text, this algorithm attempts to prevent it from
2236 appearing as a deletion or addition in the output. It uses the "patience
2237 diff" algorithm internally.</p></div>
2238 </dd>
2239 <dt class="hdlist1">
2240 --diff-algorithm={patience|minimal|histogram|myers}
2241 </dt>
2242 <dd>
2244 Choose a diff algorithm. The variants are as follows:
2245 </p>
2246 <div class="openblock">
2247 <div class="content">
2248 <div class="dlist"><dl>
2249 <dt class="hdlist1">
2250 <code>default</code>, <code>myers</code>
2251 </dt>
2252 <dd>
2254 The basic greedy diff algorithm. Currently, this is the default.
2255 </p>
2256 </dd>
2257 <dt class="hdlist1">
2258 <code>minimal</code>
2259 </dt>
2260 <dd>
2262 Spend extra time to make sure the smallest possible diff is
2263 produced.
2264 </p>
2265 </dd>
2266 <dt class="hdlist1">
2267 <code>patience</code>
2268 </dt>
2269 <dd>
2271 Use "patience diff" algorithm when generating patches.
2272 </p>
2273 </dd>
2274 <dt class="hdlist1">
2275 <code>histogram</code>
2276 </dt>
2277 <dd>
2279 This algorithm extends the patience algorithm to "support
2280 low-occurrence common elements".
2281 </p>
2282 </dd>
2283 </dl></div>
2284 </div></div>
2285 <div class="paragraph"><p>For instance, if you configured the <code>diff.algorithm</code> variable to a
2286 non-default value and want to use the default one, then you
2287 have to use <code>--diff-algorithm=default</code> option.</p></div>
2288 </dd>
2289 <dt class="hdlist1">
2290 --stat[=&lt;width&gt;[,&lt;name-width&gt;[,&lt;count&gt;]]]
2291 </dt>
2292 <dd>
2294 Generate a diffstat. By default, as much space as necessary
2295 will be used for the filename part, and the rest for the graph
2296 part. Maximum width defaults to terminal width, or 80 columns
2297 if not connected to a terminal, and can be overridden by
2298 <code>&lt;width&gt;</code>. The width of the filename part can be limited by
2299 giving another width <code>&lt;name-width&gt;</code> after a comma. The width
2300 of the graph part can be limited by using
2301 <code>--stat-graph-width=&lt;width&gt;</code> (affects all commands generating
2302 a stat graph) or by setting <code>diff.statGraphWidth=&lt;width&gt;</code>
2303 (does not affect <code>git format-patch</code>).
2304 By giving a third parameter <code>&lt;count&gt;</code>, you can limit the
2305 output to the first <code>&lt;count&gt;</code> lines, followed by <code>...</code> if
2306 there are more.
2307 </p>
2308 <div class="paragraph"><p>These parameters can also be set individually with <code>--stat-width=&lt;width&gt;</code>,
2309 <code>--stat-name-width=&lt;name-width&gt;</code> and <code>--stat-count=&lt;count&gt;</code>.</p></div>
2310 </dd>
2311 <dt class="hdlist1">
2312 --compact-summary
2313 </dt>
2314 <dd>
2316 Output a condensed summary of extended header information such
2317 as file creations or deletions ("new" or "gone", optionally "+l"
2318 if it&#8217;s a symlink) and mode changes ("+x" or "-x" for adding
2319 or removing executable bit respectively) in diffstat. The
2320 information is put between the filename part and the graph
2321 part. Implies <code>--stat</code>.
2322 </p>
2323 </dd>
2324 <dt class="hdlist1">
2325 --numstat
2326 </dt>
2327 <dd>
2329 Similar to <code>--stat</code>, but shows number of added and
2330 deleted lines in decimal notation and pathname without
2331 abbreviation, to make it more machine friendly. For
2332 binary files, outputs two <code>-</code> instead of saying
2333 <code>0 0</code>.
2334 </p>
2335 </dd>
2336 <dt class="hdlist1">
2337 --shortstat
2338 </dt>
2339 <dd>
2341 Output only the last line of the <code>--stat</code> format containing total
2342 number of modified files, as well as number of added and deleted
2343 lines.
2344 </p>
2345 </dd>
2346 <dt class="hdlist1">
2347 -X[&lt;param1,param2,&#8230;&gt;]
2348 </dt>
2349 <dt class="hdlist1">
2350 --dirstat[=&lt;param1,param2,&#8230;&gt;]
2351 </dt>
2352 <dd>
2354 Output the distribution of relative amount of changes for each
2355 sub-directory. The behavior of <code>--dirstat</code> can be customized by
2356 passing it a comma separated list of parameters.
2357 The defaults are controlled by the <code>diff.dirstat</code> configuration
2358 variable (see <a href="git-config.html">git-config(1)</a>).
2359 The following parameters are available:
2360 </p>
2361 <div class="openblock">
2362 <div class="content">
2363 <div class="dlist"><dl>
2364 <dt class="hdlist1">
2365 <code>changes</code>
2366 </dt>
2367 <dd>
2369 Compute the dirstat numbers by counting the lines that have been
2370 removed from the source, or added to the destination. This ignores
2371 the amount of pure code movements within a file. In other words,
2372 rearranging lines in a file is not counted as much as other changes.
2373 This is the default behavior when no parameter is given.
2374 </p>
2375 </dd>
2376 <dt class="hdlist1">
2377 <code>lines</code>
2378 </dt>
2379 <dd>
2381 Compute the dirstat numbers by doing the regular line-based diff
2382 analysis, and summing the removed/added line counts. (For binary
2383 files, count 64-byte chunks instead, since binary files have no
2384 natural concept of lines). This is a more expensive <code>--dirstat</code>
2385 behavior than the <code>changes</code> behavior, but it does count rearranged
2386 lines within a file as much as other changes. The resulting output
2387 is consistent with what you get from the other <code>--*stat</code> options.
2388 </p>
2389 </dd>
2390 <dt class="hdlist1">
2391 <code>files</code>
2392 </dt>
2393 <dd>
2395 Compute the dirstat numbers by counting the number of files changed.
2396 Each changed file counts equally in the dirstat analysis. This is
2397 the computationally cheapest <code>--dirstat</code> behavior, since it does
2398 not have to look at the file contents at all.
2399 </p>
2400 </dd>
2401 <dt class="hdlist1">
2402 <code>cumulative</code>
2403 </dt>
2404 <dd>
2406 Count changes in a child directory for the parent directory as well.
2407 Note that when using <code>cumulative</code>, the sum of the percentages
2408 reported may exceed 100%. The default (non-cumulative) behavior can
2409 be specified with the <code>noncumulative</code> parameter.
2410 </p>
2411 </dd>
2412 <dt class="hdlist1">
2413 &lt;limit&gt;
2414 </dt>
2415 <dd>
2417 An integer parameter specifies a cut-off percent (3% by default).
2418 Directories contributing less than this percentage of the changes
2419 are not shown in the output.
2420 </p>
2421 </dd>
2422 </dl></div>
2423 </div></div>
2424 <div class="paragraph"><p>Example: The following will count changed files, while ignoring
2425 directories with less than 10% of the total amount of changed files,
2426 and accumulating child directory counts in the parent directories:
2427 <code>--dirstat=files,10,cumulative</code>.</p></div>
2428 </dd>
2429 <dt class="hdlist1">
2430 --cumulative
2431 </dt>
2432 <dd>
2434 Synonym for --dirstat=cumulative
2435 </p>
2436 </dd>
2437 <dt class="hdlist1">
2438 --dirstat-by-file[=&lt;param1,param2&gt;&#8230;]
2439 </dt>
2440 <dd>
2442 Synonym for --dirstat=files,param1,param2&#8230;
2443 </p>
2444 </dd>
2445 <dt class="hdlist1">
2446 --summary
2447 </dt>
2448 <dd>
2450 Output a condensed summary of extended header information
2451 such as creations, renames and mode changes.
2452 </p>
2453 </dd>
2454 <dt class="hdlist1">
2455 --patch-with-stat
2456 </dt>
2457 <dd>
2459 Synonym for <code>-p --stat</code>.
2460 </p>
2461 </dd>
2462 <dt class="hdlist1">
2464 </dt>
2465 <dd>
2467 Separate the commits with NULs instead of with new newlines.
2468 </p>
2469 <div class="paragraph"><p>Also, when <code>--raw</code> or <code>--numstat</code> has been given, do not munge
2470 pathnames and use NULs as output field terminators.</p></div>
2471 <div class="paragraph"><p>Without this option, pathnames with "unusual" characters are quoted as
2472 explained for the configuration variable <code>core.quotePath</code> (see
2473 <a href="git-config.html">git-config(1)</a>).</p></div>
2474 </dd>
2475 <dt class="hdlist1">
2476 --name-only
2477 </dt>
2478 <dd>
2480 Show only names of changed files. The file names are often encoded in UTF-8.
2481 For more information see the discussion about encoding in the <a href="git-log.html">git-log(1)</a>
2482 manual page.
2483 </p>
2484 </dd>
2485 <dt class="hdlist1">
2486 --name-status
2487 </dt>
2488 <dd>
2490 Show only names and status of changed files. See the description
2491 of the <code>--diff-filter</code> option on what the status letters mean.
2492 Just like <code>--name-only</code> the file names are often encoded in UTF-8.
2493 </p>
2494 </dd>
2495 <dt class="hdlist1">
2496 --submodule[=&lt;format&gt;]
2497 </dt>
2498 <dd>
2500 Specify how differences in submodules are shown. When specifying
2501 <code>--submodule=short</code> the <em>short</em> format is used. This format just
2502 shows the names of the commits at the beginning and end of the range.
2503 When <code>--submodule</code> or <code>--submodule=log</code> is specified, the <em>log</em>
2504 format is used. This format lists the commits in the range like
2505 <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code> does. When <code>--submodule=diff</code>
2506 is specified, the <em>diff</em> format is used. This format shows an
2507 inline diff of the changes in the submodule contents between the
2508 commit range. Defaults to <code>diff.submodule</code> or the <em>short</em> format
2509 if the config option is unset.
2510 </p>
2511 </dd>
2512 <dt class="hdlist1">
2513 --color[=&lt;when&gt;]
2514 </dt>
2515 <dd>
2517 Show colored diff.
2518 <code>--color</code> (i.e. without <em>=&lt;when&gt;</em>) is the same as <code>--color=always</code>.
2519 <em>&lt;when&gt;</em> can be one of <code>always</code>, <code>never</code>, or <code>auto</code>.
2520 </p>
2521 </dd>
2522 <dt class="hdlist1">
2523 --no-color
2524 </dt>
2525 <dd>
2527 Turn off colored diff.
2528 It is the same as <code>--color=never</code>.
2529 </p>
2530 </dd>
2531 <dt class="hdlist1">
2532 --color-moved[=&lt;mode&gt;]
2533 </dt>
2534 <dd>
2536 Moved lines of code are colored differently.
2537 The &lt;mode&gt; defaults to <em>no</em> if the option is not given
2538 and to <em>zebra</em> if the option with no mode is given.
2539 The mode must be one of:
2540 </p>
2541 <div class="openblock">
2542 <div class="content">
2543 <div class="dlist"><dl>
2544 <dt class="hdlist1">
2546 </dt>
2547 <dd>
2549 Moved lines are not highlighted.
2550 </p>
2551 </dd>
2552 <dt class="hdlist1">
2553 default
2554 </dt>
2555 <dd>
2557 Is a synonym for <code>zebra</code>. This may change to a more sensible mode
2558 in the future.
2559 </p>
2560 </dd>
2561 <dt class="hdlist1">
2562 plain
2563 </dt>
2564 <dd>
2566 Any line that is added in one location and was removed
2567 in another location will be colored with <em>color.diff.newMoved</em>.
2568 Similarly <em>color.diff.oldMoved</em> will be used for removed lines
2569 that are added somewhere else in the diff. This mode picks up any
2570 moved line, but it is not very useful in a review to determine
2571 if a block of code was moved without permutation.
2572 </p>
2573 </dd>
2574 <dt class="hdlist1">
2575 blocks
2576 </dt>
2577 <dd>
2579 Blocks of moved text of at least 20 alphanumeric characters
2580 are detected greedily. The detected blocks are
2581 painted using either the <em>color.diff.{old,new}Moved</em> color.
2582 Adjacent blocks cannot be told apart.
2583 </p>
2584 </dd>
2585 <dt class="hdlist1">
2586 zebra
2587 </dt>
2588 <dd>
2590 Blocks of moved text are detected as in <em>blocks</em> mode. The blocks
2591 are painted using either the <em>color.diff.{old,new}Moved</em> color or
2592 <em>color.diff.{old,new}MovedAlternative</em>. The change between
2593 the two colors indicates that a new block was detected.
2594 </p>
2595 </dd>
2596 <dt class="hdlist1">
2597 dimmed-zebra
2598 </dt>
2599 <dd>
2601 Similar to <em>zebra</em>, but additional dimming of uninteresting parts
2602 of moved code is performed. The bordering lines of two adjacent
2603 blocks are considered interesting, the rest is uninteresting.
2604 <code>dimmed_zebra</code> is a deprecated synonym.
2605 </p>
2606 </dd>
2607 </dl></div>
2608 </div></div>
2609 </dd>
2610 <dt class="hdlist1">
2611 --no-color-moved
2612 </dt>
2613 <dd>
2615 Turn off move detection. This can be used to override configuration
2616 settings. It is the same as <code>--color-moved=no</code>.
2617 </p>
2618 </dd>
2619 <dt class="hdlist1">
2620 --color-moved-ws=&lt;modes&gt;
2621 </dt>
2622 <dd>
2624 This configures how whitespace is ignored when performing the
2625 move detection for <code>--color-moved</code>.
2626 These modes can be given as a comma separated list:
2627 </p>
2628 <div class="openblock">
2629 <div class="content">
2630 <div class="dlist"><dl>
2631 <dt class="hdlist1">
2633 </dt>
2634 <dd>
2636 Do not ignore whitespace when performing move detection.
2637 </p>
2638 </dd>
2639 <dt class="hdlist1">
2640 ignore-space-at-eol
2641 </dt>
2642 <dd>
2644 Ignore changes in whitespace at EOL.
2645 </p>
2646 </dd>
2647 <dt class="hdlist1">
2648 ignore-space-change
2649 </dt>
2650 <dd>
2652 Ignore changes in amount of whitespace. This ignores whitespace
2653 at line end, and considers all other sequences of one or
2654 more whitespace characters to be equivalent.
2655 </p>
2656 </dd>
2657 <dt class="hdlist1">
2658 ignore-all-space
2659 </dt>
2660 <dd>
2662 Ignore whitespace when comparing lines. This ignores differences
2663 even if one line has whitespace where the other line has none.
2664 </p>
2665 </dd>
2666 <dt class="hdlist1">
2667 allow-indentation-change
2668 </dt>
2669 <dd>
2671 Initially ignore any whitespace in the move detection, then
2672 group the moved code blocks only into a block if the change in
2673 whitespace is the same per line. This is incompatible with the
2674 other modes.
2675 </p>
2676 </dd>
2677 </dl></div>
2678 </div></div>
2679 </dd>
2680 <dt class="hdlist1">
2681 --no-color-moved-ws
2682 </dt>
2683 <dd>
2685 Do not ignore whitespace when performing move detection. This can be
2686 used to override configuration settings. It is the same as
2687 <code>--color-moved-ws=no</code>.
2688 </p>
2689 </dd>
2690 <dt class="hdlist1">
2691 --word-diff[=&lt;mode&gt;]
2692 </dt>
2693 <dd>
2695 Show a word diff, using the &lt;mode&gt; to delimit changed words.
2696 By default, words are delimited by whitespace; see
2697 <code>--word-diff-regex</code> below. The &lt;mode&gt; defaults to <em>plain</em>, and
2698 must be one of:
2699 </p>
2700 <div class="openblock">
2701 <div class="content">
2702 <div class="dlist"><dl>
2703 <dt class="hdlist1">
2704 color
2705 </dt>
2706 <dd>
2708 Highlight changed words using only colors. Implies <code>--color</code>.
2709 </p>
2710 </dd>
2711 <dt class="hdlist1">
2712 plain
2713 </dt>
2714 <dd>
2716 Show words as <code>[-removed-]</code> and <code>{+added+}</code>. Makes no
2717 attempts to escape the delimiters if they appear in the input,
2718 so the output may be ambiguous.
2719 </p>
2720 </dd>
2721 <dt class="hdlist1">
2722 porcelain
2723 </dt>
2724 <dd>
2726 Use a special line-based format intended for script
2727 consumption. Added/removed/unchanged runs are printed in the
2728 usual unified diff format, starting with a <code>+</code>/<code>-</code>/` `
2729 character at the beginning of the line and extending to the
2730 end of the line. Newlines in the input are represented by a
2731 tilde <code>~</code> on a line of its own.
2732 </p>
2733 </dd>
2734 <dt class="hdlist1">
2735 none
2736 </dt>
2737 <dd>
2739 Disable word diff again.
2740 </p>
2741 </dd>
2742 </dl></div>
2743 </div></div>
2744 <div class="paragraph"><p>Note that despite the name of the first mode, color is used to
2745 highlight the changed parts in all modes if enabled.</p></div>
2746 </dd>
2747 <dt class="hdlist1">
2748 --word-diff-regex=&lt;regex&gt;
2749 </dt>
2750 <dd>
2752 Use &lt;regex&gt; to decide what a word is, instead of considering
2753 runs of non-whitespace to be a word. Also implies
2754 <code>--word-diff</code> unless it was already enabled.
2755 </p>
2756 <div class="paragraph"><p>Every non-overlapping match of the
2757 &lt;regex&gt; is considered a word. Anything between these matches is
2758 considered whitespace and ignored(!) for the purposes of finding
2759 differences. You may want to append <code>|[^[:space:]]</code> to your regular
2760 expression to make sure that it matches all non-whitespace characters.
2761 A match that contains a newline is silently truncated(!) at the
2762 newline.</p></div>
2763 <div class="paragraph"><p>For example, <code>--word-diff-regex=.</code> will treat each character as a word
2764 and, correspondingly, show differences character by character.</p></div>
2765 <div class="paragraph"><p>The regex can also be set via a diff driver or configuration option, see
2766 <a href="gitattributes.html">gitattributes(5)</a> or <a href="git-config.html">git-config(1)</a>. Giving it explicitly
2767 overrides any diff driver or configuration setting. Diff drivers
2768 override configuration settings.</p></div>
2769 </dd>
2770 <dt class="hdlist1">
2771 --color-words[=&lt;regex&gt;]
2772 </dt>
2773 <dd>
2775 Equivalent to <code>--word-diff=color</code> plus (if a regex was
2776 specified) <code>--word-diff-regex=&lt;regex&gt;</code>.
2777 </p>
2778 </dd>
2779 <dt class="hdlist1">
2780 --no-renames
2781 </dt>
2782 <dd>
2784 Turn off rename detection, even when the configuration
2785 file gives the default to do so.
2786 </p>
2787 </dd>
2788 <dt class="hdlist1">
2789 --[no-]rename-empty
2790 </dt>
2791 <dd>
2793 Whether to use empty blobs as rename source.
2794 </p>
2795 </dd>
2796 <dt class="hdlist1">
2797 --check
2798 </dt>
2799 <dd>
2801 Warn if changes introduce conflict markers or whitespace errors.
2802 What are considered whitespace errors is controlled by <code>core.whitespace</code>
2803 configuration. By default, trailing whitespaces (including
2804 lines that consist solely of whitespaces) and a space character
2805 that is immediately followed by a tab character inside the
2806 initial indent of the line are considered whitespace errors.
2807 Exits with non-zero status if problems are found. Not compatible
2808 with --exit-code.
2809 </p>
2810 </dd>
2811 <dt class="hdlist1">
2812 --ws-error-highlight=&lt;kind&gt;
2813 </dt>
2814 <dd>
2816 Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
2817 lines of the diff. Multiple values are separated by comma,
2818 <code>none</code> resets previous values, <code>default</code> reset the list to
2819 <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>. When
2820 this option is not given, and the configuration variable
2821 <code>diff.wsErrorHighlight</code> is not set, only whitespace errors in
2822 <code>new</code> lines are highlighted. The whitespace errors are colored
2823 with <code>color.diff.whitespace</code>.
2824 </p>
2825 </dd>
2826 <dt class="hdlist1">
2827 --full-index
2828 </dt>
2829 <dd>
2831 Instead of the first handful of characters, show the full
2832 pre- and post-image blob object names on the "index"
2833 line when generating patch format output.
2834 </p>
2835 </dd>
2836 <dt class="hdlist1">
2837 --binary
2838 </dt>
2839 <dd>
2841 In addition to <code>--full-index</code>, output a binary diff that
2842 can be applied with <code>git-apply</code>.
2843 Implies <code>--patch</code>.
2844 </p>
2845 </dd>
2846 <dt class="hdlist1">
2847 --abbrev[=&lt;n&gt;]
2848 </dt>
2849 <dd>
2851 Instead of showing the full 40-byte hexadecimal object
2852 name in diff-raw format output and diff-tree header
2853 lines, show the shortest prefix that is at least <em>&lt;n&gt;</em>
2854 hexdigits long that uniquely refers the object.
2855 In diff-patch output format, <code>--full-index</code> takes higher
2856 precedence, i.e. if <code>--full-index</code> is specified, full blob
2857 names will be shown regardless of <code>--abbrev</code>.
2858 Non default number of digits can be specified with <code>--abbrev=&lt;n&gt;</code>.
2859 </p>
2860 </dd>
2861 <dt class="hdlist1">
2862 -B[&lt;n&gt;][/&lt;m&gt;]
2863 </dt>
2864 <dt class="hdlist1">
2865 --break-rewrites[=[&lt;n&gt;][/&lt;m&gt;]]
2866 </dt>
2867 <dd>
2869 Break complete rewrite changes into pairs of delete and
2870 create. This serves two purposes:
2871 </p>
2872 <div class="paragraph"><p>It affects the way a change that amounts to a total rewrite of a file
2873 not as a series of deletion and insertion mixed together with a very
2874 few lines that happen to match textually as the context, but as a
2875 single deletion of everything old followed by a single insertion of
2876 everything new, and the number <code>m</code> controls this aspect of the -B
2877 option (defaults to 60%). <code>-B/70%</code> specifies that less than 30% of the
2878 original should remain in the result for Git to consider it a total
2879 rewrite (i.e. otherwise the resulting patch will be a series of
2880 deletion and insertion mixed together with context lines).</p></div>
2881 <div class="paragraph"><p>When used with -M, a totally-rewritten file is also considered as the
2882 source of a rename (usually -M only considers a file that disappeared
2883 as the source of a rename), and the number <code>n</code> controls this aspect of
2884 the -B option (defaults to 50%). <code>-B20%</code> specifies that a change with
2885 addition and deletion compared to 20% or more of the file&#8217;s size are
2886 eligible for being picked up as a possible source of a rename to
2887 another file.</p></div>
2888 </dd>
2889 <dt class="hdlist1">
2890 -M[&lt;n&gt;]
2891 </dt>
2892 <dt class="hdlist1">
2893 --find-renames[=&lt;n&gt;]
2894 </dt>
2895 <dd>
2897 If generating diffs, detect and report renames for each commit.
2898 For following files across renames while traversing history, see
2899 <code>--follow</code>.
2900 If <code>n</code> is specified, it is a threshold on the similarity
2901 index (i.e. amount of addition/deletions compared to the
2902 file&#8217;s size). For example, <code>-M90%</code> means Git should consider a
2903 delete/add pair to be a rename if more than 90% of the file
2904 hasn&#8217;t changed. Without a <code>%</code> sign, the number is to be read as
2905 a fraction, with a decimal point before it. I.e., <code>-M5</code> becomes
2906 0.5, and is thus the same as <code>-M50%</code>. Similarly, <code>-M05</code> is
2907 the same as <code>-M5%</code>. To limit detection to exact renames, use
2908 <code>-M100%</code>. The default similarity index is 50%.
2909 </p>
2910 </dd>
2911 <dt class="hdlist1">
2912 -C[&lt;n&gt;]
2913 </dt>
2914 <dt class="hdlist1">
2915 --find-copies[=&lt;n&gt;]
2916 </dt>
2917 <dd>
2919 Detect copies as well as renames. See also <code>--find-copies-harder</code>.
2920 If <code>n</code> is specified, it has the same meaning as for <code>-M&lt;n&gt;</code>.
2921 </p>
2922 </dd>
2923 <dt class="hdlist1">
2924 --find-copies-harder
2925 </dt>
2926 <dd>
2928 For performance reasons, by default, <code>-C</code> option finds copies only
2929 if the original file of the copy was modified in the same
2930 changeset. This flag makes the command
2931 inspect unmodified files as candidates for the source of
2932 copy. This is a very expensive operation for large
2933 projects, so use it with caution. Giving more than one
2934 <code>-C</code> option has the same effect.
2935 </p>
2936 </dd>
2937 <dt class="hdlist1">
2939 </dt>
2940 <dt class="hdlist1">
2941 --irreversible-delete
2942 </dt>
2943 <dd>
2945 Omit the preimage for deletes, i.e. print only the header but not
2946 the diff between the preimage and <code>/dev/null</code>. The resulting patch
2947 is not meant to be applied with <code>patch</code> or <code>git apply</code>; this is
2948 solely for people who want to just concentrate on reviewing the
2949 text after the change. In addition, the output obviously lacks
2950 enough information to apply such a patch in reverse, even manually,
2951 hence the name of the option.
2952 </p>
2953 <div class="paragraph"><p>When used together with <code>-B</code>, omit also the preimage in the deletion part
2954 of a delete/create pair.</p></div>
2955 </dd>
2956 <dt class="hdlist1">
2957 -l&lt;num&gt;
2958 </dt>
2959 <dd>
2961 The <code>-M</code> and <code>-C</code> options involve some preliminary steps that
2962 can detect subsets of renames/copies cheaply, followed by an
2963 exhaustive fallback portion that compares all remaining
2964 unpaired destinations to all relevant sources. (For renames,
2965 only remaining unpaired sources are relevant; for copies, all
2966 original sources are relevant.) For N sources and
2967 destinations, this exhaustive check is O(N^2). This option
2968 prevents the exhaustive portion of rename/copy detection from
2969 running if the number of source/destination files involved
2970 exceeds the specified number. Defaults to diff.renameLimit.
2971 Note that a value of 0 is treated as unlimited.
2972 </p>
2973 </dd>
2974 <dt class="hdlist1">
2975 --diff-filter=[(A|C|D|M|R|T|U|X|B)&#8230;[*]]
2976 </dt>
2977 <dd>
2979 Select only files that are Added (<code>A</code>), Copied (<code>C</code>),
2980 Deleted (<code>D</code>), Modified (<code>M</code>), Renamed (<code>R</code>), have their
2981 type (i.e. regular file, symlink, submodule, &#8230;) changed (<code>T</code>),
2982 are Unmerged (<code>U</code>), are
2983 Unknown (<code>X</code>), or have had their pairing Broken (<code>B</code>).
2984 Any combination of the filter characters (including none) can be used.
2985 When <code>*</code> (All-or-none) is added to the combination, all
2986 paths are selected if there is any file that matches
2987 other criteria in the comparison; if there is no file
2988 that matches other criteria, nothing is selected.
2989 </p>
2990 <div class="paragraph"><p>Also, these upper-case letters can be downcased to exclude. E.g.
2991 <code>--diff-filter=ad</code> excludes added and deleted paths.</p></div>
2992 <div class="paragraph"><p>Note that not all diffs can feature all types. For instance, copied and
2993 renamed entries cannot appear if detection for those types is disabled.</p></div>
2994 </dd>
2995 <dt class="hdlist1">
2996 -S&lt;string&gt;
2997 </dt>
2998 <dd>
3000 Look for differences that change the number of occurrences of
3001 the specified string (i.e. addition/deletion) in a file.
3002 Intended for the scripter&#8217;s use.
3003 </p>
3004 <div class="paragraph"><p>It is useful when you&#8217;re looking for an exact block of code (like a
3005 struct), and want to know the history of that block since it first
3006 came into being: use the feature iteratively to feed the interesting
3007 block in the preimage back into <code>-S</code>, and keep going until you get the
3008 very first version of the block.</p></div>
3009 <div class="paragraph"><p>Binary files are searched as well.</p></div>
3010 </dd>
3011 <dt class="hdlist1">
3012 -G&lt;regex&gt;
3013 </dt>
3014 <dd>
3016 Look for differences whose patch text contains added/removed
3017 lines that match &lt;regex&gt;.
3018 </p>
3019 <div class="paragraph"><p>To illustrate the difference between <code>-S&lt;regex&gt; --pickaxe-regex</code> and
3020 <code>-G&lt;regex&gt;</code>, consider a commit with the following diff in the same
3021 file:</p></div>
3022 <div class="listingblock">
3023 <div class="content">
3024 <pre><code>+ return frotz(nitfol, two-&gt;ptr, 1, 0);
3026 - hit = frotz(nitfol, mf2.ptr, 1, 0);</code></pre>
3027 </div></div>
3028 <div class="paragraph"><p>While <code>git log -G"frotz\(nitfol"</code> will show this commit, <code>git log
3029 -S"frotz\(nitfol" --pickaxe-regex</code> will not (because the number of
3030 occurrences of that string did not change).</p></div>
3031 <div class="paragraph"><p>Unless <code>--text</code> is supplied patches of binary files without a textconv
3032 filter will be ignored.</p></div>
3033 <div class="paragraph"><p>See the <em>pickaxe</em> entry in <a href="gitdiffcore.html">gitdiffcore(7)</a> for more
3034 information.</p></div>
3035 </dd>
3036 <dt class="hdlist1">
3037 --find-object=&lt;object-id&gt;
3038 </dt>
3039 <dd>
3041 Look for differences that change the number of occurrences of
3042 the specified object. Similar to <code>-S</code>, just the argument is different
3043 in that it doesn&#8217;t search for a specific string but for a specific
3044 object id.
3045 </p>
3046 <div class="paragraph"><p>The object can be a blob or a submodule commit. It implies the <code>-t</code> option in
3047 <code>git-log</code> to also find trees.</p></div>
3048 </dd>
3049 <dt class="hdlist1">
3050 --pickaxe-all
3051 </dt>
3052 <dd>
3054 When <code>-S</code> or <code>-G</code> finds a change, show all the changes in that
3055 changeset, not just the files that contain the change
3056 in &lt;string&gt;.
3057 </p>
3058 </dd>
3059 <dt class="hdlist1">
3060 --pickaxe-regex
3061 </dt>
3062 <dd>
3064 Treat the &lt;string&gt; given to <code>-S</code> as an extended POSIX regular
3065 expression to match.
3066 </p>
3067 </dd>
3068 <dt class="hdlist1">
3069 -O&lt;orderfile&gt;
3070 </dt>
3071 <dd>
3073 Control the order in which files appear in the output.
3074 This overrides the <code>diff.orderFile</code> configuration variable
3075 (see <a href="git-config.html">git-config(1)</a>). To cancel <code>diff.orderFile</code>,
3076 use <code>-O/dev/null</code>.
3077 </p>
3078 <div class="paragraph"><p>The output order is determined by the order of glob patterns in
3079 &lt;orderfile&gt;.
3080 All files with pathnames that match the first pattern are output
3081 first, all files with pathnames that match the second pattern (but not
3082 the first) are output next, and so on.
3083 All files with pathnames that do not match any pattern are output
3084 last, as if there was an implicit match-all pattern at the end of the
3085 file.
3086 If multiple pathnames have the same rank (they match the same pattern
3087 but no earlier patterns), their output order relative to each other is
3088 the normal order.</p></div>
3089 <div class="paragraph"><p>&lt;orderfile&gt; is parsed as follows:</p></div>
3090 <div class="openblock">
3091 <div class="content">
3092 <div class="ulist"><ul>
3093 <li>
3095 Blank lines are ignored, so they can be used as separators for
3096 readability.
3097 </p>
3098 </li>
3099 <li>
3101 Lines starting with a hash ("<code>#</code>") are ignored, so they can be used
3102 for comments. Add a backslash ("<code>\</code>") to the beginning of the
3103 pattern if it starts with a hash.
3104 </p>
3105 </li>
3106 <li>
3108 Each other line contains a single pattern.
3109 </p>
3110 </li>
3111 </ul></div>
3112 </div></div>
3113 <div class="paragraph"><p>Patterns have the same syntax and semantics as patterns used for
3114 fnmatch(3) without the FNM_PATHNAME flag, except a pathname also
3115 matches a pattern if removing any number of the final pathname
3116 components matches the pattern. For example, the pattern "<code>foo*bar</code>"
3117 matches "<code>fooasdfbar</code>" and "<code>foo/bar/baz/asdf</code>" but not "<code>foobarx</code>".</p></div>
3118 </dd>
3119 <dt class="hdlist1">
3120 --skip-to=&lt;file&gt;
3121 </dt>
3122 <dt class="hdlist1">
3123 --rotate-to=&lt;file&gt;
3124 </dt>
3125 <dd>
3127 Discard the files before the named &lt;file&gt; from the output
3128 (i.e. <em>skip to</em>), or move them to the end of the output
3129 (i.e. <em>rotate to</em>). These were invented primarily for use
3130 of the <code>git difftool</code> command, and may not be very useful
3131 otherwise.
3132 </p>
3133 </dd>
3134 <dt class="hdlist1">
3136 </dt>
3137 <dd>
3139 Swap two inputs; that is, show differences from index or
3140 on-disk file to tree contents.
3141 </p>
3142 </dd>
3143 <dt class="hdlist1">
3144 --relative[=&lt;path&gt;]
3145 </dt>
3146 <dt class="hdlist1">
3147 --no-relative
3148 </dt>
3149 <dd>
3151 When run from a subdirectory of the project, it can be
3152 told to exclude changes outside the directory and show
3153 pathnames relative to it with this option. When you are
3154 not in a subdirectory (e.g. in a bare repository), you
3155 can name which subdirectory to make the output relative
3156 to by giving a &lt;path&gt; as an argument.
3157 <code>--no-relative</code> can be used to countermand both <code>diff.relative</code> config
3158 option and previous <code>--relative</code>.
3159 </p>
3160 </dd>
3161 <dt class="hdlist1">
3163 </dt>
3164 <dt class="hdlist1">
3165 --text
3166 </dt>
3167 <dd>
3169 Treat all files as text.
3170 </p>
3171 </dd>
3172 <dt class="hdlist1">
3173 --ignore-cr-at-eol
3174 </dt>
3175 <dd>
3177 Ignore carriage-return at the end of line when doing a comparison.
3178 </p>
3179 </dd>
3180 <dt class="hdlist1">
3181 --ignore-space-at-eol
3182 </dt>
3183 <dd>
3185 Ignore changes in whitespace at EOL.
3186 </p>
3187 </dd>
3188 <dt class="hdlist1">
3190 </dt>
3191 <dt class="hdlist1">
3192 --ignore-space-change
3193 </dt>
3194 <dd>
3196 Ignore changes in amount of whitespace. This ignores whitespace
3197 at line end, and considers all other sequences of one or
3198 more whitespace characters to be equivalent.
3199 </p>
3200 </dd>
3201 <dt class="hdlist1">
3203 </dt>
3204 <dt class="hdlist1">
3205 --ignore-all-space
3206 </dt>
3207 <dd>
3209 Ignore whitespace when comparing lines. This ignores
3210 differences even if one line has whitespace where the other
3211 line has none.
3212 </p>
3213 </dd>
3214 <dt class="hdlist1">
3215 --ignore-blank-lines
3216 </dt>
3217 <dd>
3219 Ignore changes whose lines are all blank.
3220 </p>
3221 </dd>
3222 <dt class="hdlist1">
3223 -I&lt;regex&gt;
3224 </dt>
3225 <dt class="hdlist1">
3226 --ignore-matching-lines=&lt;regex&gt;
3227 </dt>
3228 <dd>
3230 Ignore changes whose all lines match &lt;regex&gt;. This option may
3231 be specified more than once.
3232 </p>
3233 </dd>
3234 <dt class="hdlist1">
3235 --inter-hunk-context=&lt;lines&gt;
3236 </dt>
3237 <dd>
3239 Show the context between diff hunks, up to the specified number
3240 of lines, thereby fusing hunks that are close to each other.
3241 Defaults to <code>diff.interHunkContext</code> or 0 if the config option
3242 is unset.
3243 </p>
3244 </dd>
3245 <dt class="hdlist1">
3247 </dt>
3248 <dt class="hdlist1">
3249 --function-context
3250 </dt>
3251 <dd>
3253 Show whole function as context lines for each change.
3254 The function names are determined in the same way as
3255 <code>git diff</code> works out patch hunk headers (see <em>Defining a
3256 custom hunk-header</em> in <a href="gitattributes.html">gitattributes(5)</a>).
3257 </p>
3258 </dd>
3259 <dt class="hdlist1">
3260 --ext-diff
3261 </dt>
3262 <dd>
3264 Allow an external diff helper to be executed. If you set an
3265 external diff driver with <a href="gitattributes.html">gitattributes(5)</a>, you need
3266 to use this option with <a href="git-log.html">git-log(1)</a> and friends.
3267 </p>
3268 </dd>
3269 <dt class="hdlist1">
3270 --no-ext-diff
3271 </dt>
3272 <dd>
3274 Disallow external diff drivers.
3275 </p>
3276 </dd>
3277 <dt class="hdlist1">
3278 --textconv
3279 </dt>
3280 <dt class="hdlist1">
3281 --no-textconv
3282 </dt>
3283 <dd>
3285 Allow (or disallow) external text conversion filters to be run
3286 when comparing binary files. See <a href="gitattributes.html">gitattributes(5)</a> for
3287 details. Because textconv filters are typically a one-way
3288 conversion, the resulting diff is suitable for human
3289 consumption, but cannot be applied. For this reason, textconv
3290 filters are enabled by default only for <a href="git-diff.html">git-diff(1)</a> and
3291 <a href="git-log.html">git-log(1)</a>, but not for <a href="git-format-patch.html">git-format-patch(1)</a> or
3292 diff plumbing commands.
3293 </p>
3294 </dd>
3295 <dt class="hdlist1">
3296 --ignore-submodules[=&lt;when&gt;]
3297 </dt>
3298 <dd>
3300 Ignore changes to submodules in the diff generation. &lt;when&gt; can be
3301 either "none", "untracked", "dirty" or "all", which is the default.
3302 Using "none" will consider the submodule modified when it either contains
3303 untracked or modified files or its HEAD differs from the commit recorded
3304 in the superproject and can be used to override any settings of the
3305 <em>ignore</em> option in <a href="git-config.html">git-config(1)</a> or <a href="gitmodules.html">gitmodules(5)</a>. When
3306 "untracked" is used submodules are not considered dirty when they only
3307 contain untracked content (but they are still scanned for modified
3308 content). Using "dirty" ignores all changes to the work tree of submodules,
3309 only changes to the commits stored in the superproject are shown (this was
3310 the behavior until 1.7.0). Using "all" hides all changes to submodules.
3311 </p>
3312 </dd>
3313 <dt class="hdlist1">
3314 --src-prefix=&lt;prefix&gt;
3315 </dt>
3316 <dd>
3318 Show the given source prefix instead of "a/".
3319 </p>
3320 </dd>
3321 <dt class="hdlist1">
3322 --dst-prefix=&lt;prefix&gt;
3323 </dt>
3324 <dd>
3326 Show the given destination prefix instead of "b/".
3327 </p>
3328 </dd>
3329 <dt class="hdlist1">
3330 --no-prefix
3331 </dt>
3332 <dd>
3334 Do not show any source or destination prefix.
3335 </p>
3336 </dd>
3337 <dt class="hdlist1">
3338 --default-prefix
3339 </dt>
3340 <dd>
3342 Use the default source and destination prefixes ("a/" and "b/").
3343 This is usually the default already, but may be used to override
3344 config such as <code>diff.noprefix</code>.
3345 </p>
3346 </dd>
3347 <dt class="hdlist1">
3348 --line-prefix=&lt;prefix&gt;
3349 </dt>
3350 <dd>
3352 Prepend an additional prefix to every line of output.
3353 </p>
3354 </dd>
3355 <dt class="hdlist1">
3356 --ita-invisible-in-index
3357 </dt>
3358 <dd>
3360 By default entries added by "git add -N" appear as an existing
3361 empty file in "git diff" and a new file in "git diff --cached".
3362 This option makes the entry appear as a new file in "git diff"
3363 and non-existent in "git diff --cached". This option could be
3364 reverted with <code>--ita-visible-in-index</code>. Both options are
3365 experimental and could be removed in future.
3366 </p>
3367 </dd>
3368 </dl></div>
3369 <div class="paragraph"><p>For more detailed explanation on these common options, see also
3370 <a href="gitdiffcore.html">gitdiffcore(7)</a>.</p></div>
3371 </div>
3372 </div>
3373 <div class="sect1">
3374 <h2 id="generate_patch_text_with_p">Generating patch text with -p</h2>
3375 <div class="sectionbody">
3376 <div class="paragraph"><p>Running
3377 <a href="git-diff.html">git-diff(1)</a>,
3378 <a href="git-log.html">git-log(1)</a>,
3379 <a href="git-show.html">git-show(1)</a>,
3380 <a href="git-diff-index.html">git-diff-index(1)</a>,
3381 <a href="git-diff-tree.html">git-diff-tree(1)</a>, or
3382 <a href="git-diff-files.html">git-diff-files(1)</a>
3383 with the <code>-p</code> option produces patch text.
3384 You can customize the creation of patch text via the
3385 <code>GIT_EXTERNAL_DIFF</code> and the <code>GIT_DIFF_OPTS</code> environment variables
3386 (see <a href="git.html">git(1)</a>), and the <code>diff</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).</p></div>
3387 <div class="paragraph"><p>What the -p option produces is slightly different from the traditional
3388 diff format:</p></div>
3389 <div class="olist arabic"><ol class="arabic">
3390 <li>
3392 It is preceded with a "git diff" header that looks like this:
3393 </p>
3394 <div class="literalblock">
3395 <div class="content">
3396 <pre><code>diff --git a/file1 b/file2</code></pre>
3397 </div></div>
3398 <div class="paragraph"><p>The <code>a/</code> and <code>b/</code> filenames are the same unless rename/copy is
3399 involved. Especially, even for a creation or a deletion,
3400 <code>/dev/null</code> is <em>not</em> used in place of the <code>a/</code> or <code>b/</code> filenames.</p></div>
3401 <div class="paragraph"><p>When rename/copy is involved, <code>file1</code> and <code>file2</code> show the
3402 name of the source file of the rename/copy and the name of
3403 the file that rename/copy produces, respectively.</p></div>
3404 </li>
3405 <li>
3407 It is followed by one or more extended header lines:
3408 </p>
3409 <div class="literalblock">
3410 <div class="content">
3411 <pre><code>old mode &lt;mode&gt;
3412 new mode &lt;mode&gt;
3413 deleted file mode &lt;mode&gt;
3414 new file mode &lt;mode&gt;
3415 copy from &lt;path&gt;
3416 copy to &lt;path&gt;
3417 rename from &lt;path&gt;
3418 rename to &lt;path&gt;
3419 similarity index &lt;number&gt;
3420 dissimilarity index &lt;number&gt;
3421 index &lt;hash&gt;..&lt;hash&gt; &lt;mode&gt;</code></pre>
3422 </div></div>
3423 <div class="paragraph"><p>File modes are printed as 6-digit octal numbers including the file type
3424 and file permission bits.</p></div>
3425 <div class="paragraph"><p>Path names in extended headers do not include the <code>a/</code> and <code>b/</code> prefixes.</p></div>
3426 <div class="paragraph"><p>The similarity index is the percentage of unchanged lines, and
3427 the dissimilarity index is the percentage of changed lines. It
3428 is a rounded down integer, followed by a percent sign. The
3429 similarity index value of 100% is thus reserved for two equal
3430 files, while 100% dissimilarity means that no line from the old
3431 file made it into the new one.</p></div>
3432 <div class="paragraph"><p>The index line includes the blob object names before and after the change.
3433 The &lt;mode&gt; is included if the file mode does not change; otherwise,
3434 separate lines indicate the old and the new mode.</p></div>
3435 </li>
3436 <li>
3438 Pathnames with "unusual" characters are quoted as explained for
3439 the configuration variable <code>core.quotePath</code> (see
3440 <a href="git-config.html">git-config(1)</a>).
3441 </p>
3442 </li>
3443 <li>
3445 All the <code>file1</code> files in the output refer to files before the
3446 commit, and all the <code>file2</code> files refer to files after the commit.
3447 It is incorrect to apply each change to each file sequentially. For
3448 example, this patch will swap a and b:
3449 </p>
3450 <div class="literalblock">
3451 <div class="content">
3452 <pre><code>diff --git a/a b/b
3453 rename from a
3454 rename to b
3455 diff --git a/b b/a
3456 rename from b
3457 rename to a</code></pre>
3458 </div></div>
3459 </li>
3460 <li>
3462 Hunk headers mention the name of the function to which the hunk
3463 applies. See "Defining a custom hunk-header" in
3464 <a href="gitattributes.html">gitattributes(5)</a> for details of how to tailor to this to
3465 specific languages.
3466 </p>
3467 </li>
3468 </ol></div>
3469 </div>
3470 </div>
3471 <div class="sect1">
3472 <h2 id="_combined_diff_format">Combined diff format</h2>
3473 <div class="sectionbody">
3474 <div class="paragraph"><p>Any diff-generating command can take the <code>-c</code> or <code>--cc</code> option to
3475 produce a <em>combined diff</em> when showing a merge. This is the default
3476 format when showing merges with <a href="git-diff.html">git-diff(1)</a> or
3477 <a href="git-show.html">git-show(1)</a>. Note also that you can give suitable
3478 <code>--diff-merges</code> option to any of these commands to force generation of
3479 diffs in specific format.</p></div>
3480 <div class="paragraph"><p>A "combined diff" format looks like this:</p></div>
3481 <div class="listingblock">
3482 <div class="content">
3483 <pre><code>diff --combined describe.c
3484 index fabadb8,cc95eb0..4866510
3485 --- a/describe.c
3486 +++ b/describe.c
3487 @@@ -98,20 -98,12 +98,20 @@@
3488 return (a_date &gt; b_date) ? -1 : (a_date == b_date) ? 0 : 1;
3491 - static void describe(char *arg)
3492 -static void describe(struct commit *cmit, int last_one)
3493 ++static void describe(char *arg, int last_one)
3495 + unsigned char sha1[20];
3496 + struct commit *cmit;
3497 struct commit_list *list;
3498 static int initialized = 0;
3499 struct commit_name *n;
3501 + if (get_sha1(arg, sha1) &lt; 0)
3502 + usage(describe_usage);
3503 + cmit = lookup_commit_reference(sha1);
3504 + if (!cmit)
3505 + usage(describe_usage);
3507 if (!initialized) {
3508 initialized = 1;
3509 for_each_ref(get_name);</code></pre>
3510 </div></div>
3511 <div class="olist arabic"><ol class="arabic">
3512 <li>
3514 It is preceded with a "git diff" header, that looks like
3515 this (when the <code>-c</code> option is used):
3516 </p>
3517 <div class="literalblock">
3518 <div class="content">
3519 <pre><code>diff --combined file</code></pre>
3520 </div></div>
3521 <div class="paragraph"><p>or like this (when the <code>--cc</code> option is used):</p></div>
3522 <div class="literalblock">
3523 <div class="content">
3524 <pre><code>diff --cc file</code></pre>
3525 </div></div>
3526 </li>
3527 <li>
3529 It is followed by one or more extended header lines
3530 (this example shows a merge with two parents):
3531 </p>
3532 <div class="literalblock">
3533 <div class="content">
3534 <pre><code>index &lt;hash&gt;,&lt;hash&gt;..&lt;hash&gt;
3535 mode &lt;mode&gt;,&lt;mode&gt;..&lt;mode&gt;
3536 new file mode &lt;mode&gt;
3537 deleted file mode &lt;mode&gt;,&lt;mode&gt;</code></pre>
3538 </div></div>
3539 <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
3540 the &lt;mode&gt; is different from the rest. Extended headers with
3541 information about detected contents movement (renames and
3542 copying detection) are designed to work with diff of two
3543 &lt;tree-ish&gt; and are not used by combined diff format.</p></div>
3544 </li>
3545 <li>
3547 It is followed by two-line from-file/to-file header
3548 </p>
3549 <div class="literalblock">
3550 <div class="content">
3551 <pre><code>--- a/file
3552 +++ b/file</code></pre>
3553 </div></div>
3554 <div class="paragraph"><p>Similar to two-line header for traditional <em>unified</em> diff
3555 format, <code>/dev/null</code> is used to signal created or deleted
3556 files.</p></div>
3557 <div class="paragraph"><p>However, if the --combined-all-paths option is provided, instead of a
3558 two-line from-file/to-file you get a N+1 line from-file/to-file header,
3559 where N is the number of parents in the merge commit</p></div>
3560 <div class="literalblock">
3561 <div class="content">
3562 <pre><code>--- a/file
3563 --- a/file
3564 --- a/file
3565 +++ b/file</code></pre>
3566 </div></div>
3567 <div class="paragraph"><p>This extended format can be useful if rename or copy detection is
3568 active, to allow you to see the original name of the file in different
3569 parents.</p></div>
3570 </li>
3571 <li>
3573 Chunk header format is modified to prevent people from
3574 accidentally feeding it to <code>patch -p1</code>. Combined diff format
3575 was created for review of merge commit changes, and was not
3576 meant to be applied. The change is similar to the change in the
3577 extended <em>index</em> header:
3578 </p>
3579 <div class="literalblock">
3580 <div class="content">
3581 <pre><code>@@@ &lt;from-file-range&gt; &lt;from-file-range&gt; &lt;to-file-range&gt; @@@</code></pre>
3582 </div></div>
3583 <div class="paragraph"><p>There are (number of parents + 1) <code>@</code> characters in the chunk
3584 header for combined diff format.</p></div>
3585 </li>
3586 </ol></div>
3587 <div class="paragraph"><p>Unlike the traditional <em>unified</em> diff format, which shows two
3588 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
3589 added to B), or <code>" "</code> (space&#8201;&#8212;&#8201;unchanged) prefix, this format
3590 compares two or more files file1, file2,&#8230; with one file X, and
3591 shows how X differs from each of fileN. One column for each of
3592 fileN is prepended to the output line to note how X&#8217;s line is
3593 different from it.</p></div>
3594 <div class="paragraph"><p>A <code>-</code> character in the column N means that the line appears in
3595 fileN but it does not appear in the result. A <code>+</code> character
3596 in the column N means that the line appears in the result,
3597 and fileN does not have that line (in other words, the line was
3598 added, from the point of view of that parent).</p></div>
3599 <div class="paragraph"><p>In the above example output, the function signature was changed
3600 from both files (hence two <code>-</code> removals from both file1 and
3601 file2, plus <code>++</code> to mean one line that was added does not appear
3602 in either file1 or file2). Also eight other lines are the same
3603 from file1 but do not appear in file2 (hence prefixed with <code>+</code>).</p></div>
3604 <div class="paragraph"><p>When shown by <code>git diff-tree -c</code>, it compares the parents of a
3605 merge commit with the merge result (i.e. file1..fileN are the
3606 parents). When shown by <code>git diff-files -c</code>, it compares the
3607 two unresolved merge parents with the working tree file
3608 (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka
3609 "their version").</p></div>
3610 </div>
3611 </div>
3612 <div class="sect1">
3613 <h2 id="_examples">EXAMPLES</h2>
3614 <div class="sectionbody">
3615 <div class="dlist"><dl>
3616 <dt class="hdlist1">
3617 <code>git show v1.0.0</code>
3618 </dt>
3619 <dd>
3621 Shows the tag <code>v1.0.0</code>, along with the object the tags
3622 points at.
3623 </p>
3624 </dd>
3625 <dt class="hdlist1">
3626 <code>git show v1.0.0^{tree}</code>
3627 </dt>
3628 <dd>
3630 Shows the tree pointed to by the tag <code>v1.0.0</code>.
3631 </p>
3632 </dd>
3633 <dt class="hdlist1">
3634 <code>git show -s --format=%s v1.0.0^{commit}</code>
3635 </dt>
3636 <dd>
3638 Shows the subject of the commit pointed to by the
3639 tag <code>v1.0.0</code>.
3640 </p>
3641 </dd>
3642 <dt class="hdlist1">
3643 <code>git show next~10:Documentation/README</code>
3644 </dt>
3645 <dd>
3647 Shows the contents of the file <code>Documentation/README</code> as
3648 they were current in the 10th last commit of the branch
3649 <code>next</code>.
3650 </p>
3651 </dd>
3652 <dt class="hdlist1">
3653 <code>git show master:Makefile master:t/Makefile</code>
3654 </dt>
3655 <dd>
3657 Concatenates the contents of said Makefiles in the head
3658 of the branch <code>master</code>.
3659 </p>
3660 </dd>
3661 </dl></div>
3662 </div>
3663 </div>
3664 <div class="sect1">
3665 <h2 id="_discussion">DISCUSSION</h2>
3666 <div class="sectionbody">
3667 <div class="paragraph"><p>Git is to some extent character encoding agnostic.</p></div>
3668 <div class="ulist"><ul>
3669 <li>
3671 The contents of the blob objects are uninterpreted sequences
3672 of bytes. There is no encoding translation at the core
3673 level.
3674 </p>
3675 </li>
3676 <li>
3678 Path names are encoded in UTF-8 normalization form C. This
3679 applies to tree objects, the index file, ref names, as well as
3680 path names in command line arguments, environment variables
3681 and config files (<code>.git/config</code> (see <a href="git-config.html">git-config(1)</a>),
3682 <a href="gitignore.html">gitignore(5)</a>, <a href="gitattributes.html">gitattributes(5)</a> and
3683 <a href="gitmodules.html">gitmodules(5)</a>).
3684 </p>
3685 <div class="paragraph"><p>Note that Git at the core level treats path names simply as
3686 sequences of non-NUL bytes, there are no path name encoding
3687 conversions (except on Mac and Windows). Therefore, using
3688 non-ASCII path names will mostly work even on platforms and file
3689 systems that use legacy extended ASCII encodings. However,
3690 repositories created on such systems will not work properly on
3691 UTF-8-based systems (e.g. Linux, Mac, Windows) and vice versa.
3692 Additionally, many Git-based tools simply assume path names to
3693 be UTF-8 and will fail to display other encodings correctly.</p></div>
3694 </li>
3695 <li>
3697 Commit log messages are typically encoded in UTF-8, but other
3698 extended ASCII encodings are also supported. This includes
3699 ISO-8859-x, CP125x and many others, but <em>not</em> UTF-16/32,
3700 EBCDIC and CJK multi-byte encodings (GBK, Shift-JIS, Big5,
3701 EUC-x, CP9xx etc.).
3702 </p>
3703 </li>
3704 </ul></div>
3705 <div class="paragraph"><p>Although we encourage that the commit log messages are encoded
3706 in UTF-8, both the core and Git Porcelain are designed not to
3707 force UTF-8 on projects. If all participants of a particular
3708 project find it more convenient to use legacy encodings, Git
3709 does not forbid it. However, there are a few things to keep in
3710 mind.</p></div>
3711 <div class="olist arabic"><ol class="arabic">
3712 <li>
3714 <em>git commit</em> and <em>git commit-tree</em> issues
3715 a warning if the commit log message given to it does not look
3716 like a valid UTF-8 string, unless you explicitly say your
3717 project uses a legacy encoding. The way to say this is to
3718 have <code>i18n.commitEncoding</code> in <code>.git/config</code> file, like this:
3719 </p>
3720 <div class="listingblock">
3721 <div class="content">
3722 <pre><code>[i18n]
3723 commitEncoding = ISO-8859-1</code></pre>
3724 </div></div>
3725 <div class="paragraph"><p>Commit objects created with the above setting record the value
3726 of <code>i18n.commitEncoding</code> in its <code>encoding</code> header. This is to
3727 help other people who look at them later. Lack of this header
3728 implies that the commit log message is encoded in UTF-8.</p></div>
3729 </li>
3730 <li>
3732 <em>git log</em>, <em>git show</em>, <em>git blame</em> and friends look at the
3733 <code>encoding</code> header of a commit object, and try to re-code the
3734 log message into UTF-8 unless otherwise specified. You can
3735 specify the desired output encoding with
3736 <code>i18n.logOutputEncoding</code> in <code>.git/config</code> file, like this:
3737 </p>
3738 <div class="listingblock">
3739 <div class="content">
3740 <pre><code>[i18n]
3741 logOutputEncoding = ISO-8859-1</code></pre>
3742 </div></div>
3743 <div class="paragraph"><p>If you do not have this configuration variable, the value of
3744 <code>i18n.commitEncoding</code> is used instead.</p></div>
3745 </li>
3746 </ol></div>
3747 <div class="paragraph"><p>Note that we deliberately chose not to re-code the commit log
3748 message when a commit is made to force UTF-8 at the commit
3749 object level, because re-coding to UTF-8 is not necessarily a
3750 reversible operation.</p></div>
3751 </div>
3752 </div>
3753 <div class="sect1">
3754 <h2 id="_git">GIT</h2>
3755 <div class="sectionbody">
3756 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
3757 </div>
3758 </div>
3759 </div>
3760 <div id="footnotes"><hr /></div>
3761 <div id="footer">
3762 <div id="footer-text">
3763 Last updated
3764 2021-02-05 22:36:43 PST
3765 </div>
3766 </div>
3767 </body>
3768 </html>