Autogenerated HTML docs for v2.45.1-204-gd8ab1
[git-htmldocs.git] / git-diff-index.html
blob8ccf040b069080d882f9fd954523ed69e71368da
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-diff-index(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-diff-index(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-diff-index -
743 Compare a tree to the working tree or index
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 diff-index</em> [-m] [--cached] [--merge-base] [&lt;common-diff-options&gt;] &lt;tree-ish&gt; [&lt;path&gt;&#8230;]</pre>
753 <div class="attribution">
754 </div></div>
755 </div>
756 </div>
757 <div class="sect1">
758 <h2 id="_description">DESCRIPTION</h2>
759 <div class="sectionbody">
760 <div class="paragraph"><p>Compare the content and mode of the blobs found in a tree object
761 with the corresponding tracked files in the working tree, or with the
762 corresponding paths in the index. When &lt;path&gt; arguments are present,
763 compare only paths matching those patterns. Otherwise all tracked
764 files are compared.</p></div>
765 </div>
766 </div>
767 <div class="sect1">
768 <h2 id="_options">OPTIONS</h2>
769 <div class="sectionbody">
770 <div class="dlist"><dl>
771 <dt class="hdlist1">
773 </dt>
774 <dt class="hdlist1">
776 </dt>
777 <dt class="hdlist1">
778 --patch
779 </dt>
780 <dd>
782 Generate patch (see <a href="#generate_patch_text_with_p">[generate_patch_text_with_p]</a>).
783 </p>
784 </dd>
785 <dt class="hdlist1">
787 </dt>
788 <dt class="hdlist1">
789 --no-patch
790 </dt>
791 <dd>
793 Suppress all output from the diff machinery. Useful for
794 commands like <code>git show</code> that show the patch by default to
795 squelch their output, or to cancel the effect of options like
796 <code>--patch</code>, <code>--stat</code> earlier on the command line in an alias.
797 </p>
798 </dd>
799 <dt class="hdlist1">
800 -U&lt;n&gt;
801 </dt>
802 <dt class="hdlist1">
803 --unified=&lt;n&gt;
804 </dt>
805 <dd>
807 Generate diffs with &lt;n&gt; lines of context instead of
808 the usual three.
809 Implies <code>--patch</code>.
810 </p>
811 </dd>
812 <dt class="hdlist1">
813 --output=&lt;file&gt;
814 </dt>
815 <dd>
817 Output to a specific file instead of stdout.
818 </p>
819 </dd>
820 <dt class="hdlist1">
821 --output-indicator-new=&lt;char&gt;
822 </dt>
823 <dt class="hdlist1">
824 --output-indicator-old=&lt;char&gt;
825 </dt>
826 <dt class="hdlist1">
827 --output-indicator-context=&lt;char&gt;
828 </dt>
829 <dd>
831 Specify the character used to indicate new, old or context
832 lines in the generated patch. Normally they are <em>+</em>, <em>-</em> and
833 ' ' respectively.
834 </p>
835 </dd>
836 <dt class="hdlist1">
837 --raw
838 </dt>
839 <dd>
841 Generate the diff in raw format.
842 This is the default.
843 </p>
844 </dd>
845 <dt class="hdlist1">
846 --patch-with-raw
847 </dt>
848 <dd>
850 Synonym for <code>-p --raw</code>.
851 </p>
852 </dd>
853 <dt class="hdlist1">
854 --indent-heuristic
855 </dt>
856 <dd>
858 Enable the heuristic that shifts diff hunk boundaries to make patches
859 easier to read. This is the default.
860 </p>
861 </dd>
862 <dt class="hdlist1">
863 --no-indent-heuristic
864 </dt>
865 <dd>
867 Disable the indent heuristic.
868 </p>
869 </dd>
870 <dt class="hdlist1">
871 --minimal
872 </dt>
873 <dd>
875 Spend extra time to make sure the smallest possible
876 diff is produced.
877 </p>
878 </dd>
879 <dt class="hdlist1">
880 --patience
881 </dt>
882 <dd>
884 Generate a diff using the "patience diff" algorithm.
885 </p>
886 </dd>
887 <dt class="hdlist1">
888 --histogram
889 </dt>
890 <dd>
892 Generate a diff using the "histogram diff" algorithm.
893 </p>
894 </dd>
895 <dt class="hdlist1">
896 --anchored=&lt;text&gt;
897 </dt>
898 <dd>
900 Generate a diff using the "anchored diff" algorithm.
901 </p>
902 <div class="paragraph"><p>This option may be specified more than once.</p></div>
903 <div class="paragraph"><p>If a line exists in both the source and destination, exists only once,
904 and starts with this text, this algorithm attempts to prevent it from
905 appearing as a deletion or addition in the output. It uses the "patience
906 diff" algorithm internally.</p></div>
907 </dd>
908 <dt class="hdlist1">
909 --diff-algorithm={patience|minimal|histogram|myers}
910 </dt>
911 <dd>
913 Choose a diff algorithm. The variants are as follows:
914 </p>
915 <div class="openblock">
916 <div class="content">
917 <div class="dlist"><dl>
918 <dt class="hdlist1">
919 <code>default</code>, <code>myers</code>
920 </dt>
921 <dd>
923 The basic greedy diff algorithm. Currently, this is the default.
924 </p>
925 </dd>
926 <dt class="hdlist1">
927 <code>minimal</code>
928 </dt>
929 <dd>
931 Spend extra time to make sure the smallest possible diff is
932 produced.
933 </p>
934 </dd>
935 <dt class="hdlist1">
936 <code>patience</code>
937 </dt>
938 <dd>
940 Use "patience diff" algorithm when generating patches.
941 </p>
942 </dd>
943 <dt class="hdlist1">
944 <code>histogram</code>
945 </dt>
946 <dd>
948 This algorithm extends the patience algorithm to "support
949 low-occurrence common elements".
950 </p>
951 </dd>
952 </dl></div>
953 </div></div>
954 <div class="paragraph"><p>For instance, if you configured the <code>diff.algorithm</code> variable to a
955 non-default value and want to use the default one, then you
956 have to use <code>--diff-algorithm=default</code> option.</p></div>
957 </dd>
958 <dt class="hdlist1">
959 --stat[=&lt;width&gt;[,&lt;name-width&gt;[,&lt;count&gt;]]]
960 </dt>
961 <dd>
963 Generate a diffstat. By default, as much space as necessary
964 will be used for the filename part, and the rest for the graph
965 part. Maximum width defaults to terminal width, or 80 columns
966 if not connected to a terminal, and can be overridden by
967 <code>&lt;width&gt;</code>. The width of the filename part can be limited by
968 giving another width <code>&lt;name-width&gt;</code> after a comma or by setting
969 <code>diff.statNameWidth=&lt;width&gt;</code>. The width of the graph part can be
970 limited by using <code>--stat-graph-width=&lt;width&gt;</code> or by setting
971 <code>diff.statGraphWidth=&lt;width&gt;</code>. Using <code>--stat</code> or
972 <code>--stat-graph-width</code> affects all commands generating a stat graph,
973 while setting <code>diff.statNameWidth</code> or <code>diff.statGraphWidth</code>
974 does not affect <code>git format-patch</code>.
975 By giving a third parameter <code>&lt;count&gt;</code>, you can limit the output to
976 the first <code>&lt;count&gt;</code> lines, followed by <code>...</code> if there are more.
977 </p>
978 <div class="paragraph"><p>These parameters can also be set individually with <code>--stat-width=&lt;width&gt;</code>,
979 <code>--stat-name-width=&lt;name-width&gt;</code> and <code>--stat-count=&lt;count&gt;</code>.</p></div>
980 </dd>
981 <dt class="hdlist1">
982 --compact-summary
983 </dt>
984 <dd>
986 Output a condensed summary of extended header information such
987 as file creations or deletions ("new" or "gone", optionally "+l"
988 if it&#8217;s a symlink) and mode changes ("+x" or "-x" for adding
989 or removing executable bit respectively) in diffstat. The
990 information is put between the filename part and the graph
991 part. Implies <code>--stat</code>.
992 </p>
993 </dd>
994 <dt class="hdlist1">
995 --numstat
996 </dt>
997 <dd>
999 Similar to <code>--stat</code>, but shows number of added and
1000 deleted lines in decimal notation and pathname without
1001 abbreviation, to make it more machine friendly. For
1002 binary files, outputs two <code>-</code> instead of saying
1003 <code>0 0</code>.
1004 </p>
1005 </dd>
1006 <dt class="hdlist1">
1007 --shortstat
1008 </dt>
1009 <dd>
1011 Output only the last line of the <code>--stat</code> format containing total
1012 number of modified files, as well as number of added and deleted
1013 lines.
1014 </p>
1015 </dd>
1016 <dt class="hdlist1">
1017 -X[&lt;param1,param2,&#8230;&gt;]
1018 </dt>
1019 <dt class="hdlist1">
1020 --dirstat[=&lt;param1,param2,&#8230;&gt;]
1021 </dt>
1022 <dd>
1024 Output the distribution of relative amount of changes for each
1025 sub-directory. The behavior of <code>--dirstat</code> can be customized by
1026 passing it a comma separated list of parameters.
1027 The defaults are controlled by the <code>diff.dirstat</code> configuration
1028 variable (see <a href="git-config.html">git-config(1)</a>).
1029 The following parameters are available:
1030 </p>
1031 <div class="openblock">
1032 <div class="content">
1033 <div class="dlist"><dl>
1034 <dt class="hdlist1">
1035 <code>changes</code>
1036 </dt>
1037 <dd>
1039 Compute the dirstat numbers by counting the lines that have been
1040 removed from the source, or added to the destination. This ignores
1041 the amount of pure code movements within a file. In other words,
1042 rearranging lines in a file is not counted as much as other changes.
1043 This is the default behavior when no parameter is given.
1044 </p>
1045 </dd>
1046 <dt class="hdlist1">
1047 <code>lines</code>
1048 </dt>
1049 <dd>
1051 Compute the dirstat numbers by doing the regular line-based diff
1052 analysis, and summing the removed/added line counts. (For binary
1053 files, count 64-byte chunks instead, since binary files have no
1054 natural concept of lines). This is a more expensive <code>--dirstat</code>
1055 behavior than the <code>changes</code> behavior, but it does count rearranged
1056 lines within a file as much as other changes. The resulting output
1057 is consistent with what you get from the other <code>--*stat</code> options.
1058 </p>
1059 </dd>
1060 <dt class="hdlist1">
1061 <code>files</code>
1062 </dt>
1063 <dd>
1065 Compute the dirstat numbers by counting the number of files changed.
1066 Each changed file counts equally in the dirstat analysis. This is
1067 the computationally cheapest <code>--dirstat</code> behavior, since it does
1068 not have to look at the file contents at all.
1069 </p>
1070 </dd>
1071 <dt class="hdlist1">
1072 <code>cumulative</code>
1073 </dt>
1074 <dd>
1076 Count changes in a child directory for the parent directory as well.
1077 Note that when using <code>cumulative</code>, the sum of the percentages
1078 reported may exceed 100%. The default (non-cumulative) behavior can
1079 be specified with the <code>noncumulative</code> parameter.
1080 </p>
1081 </dd>
1082 <dt class="hdlist1">
1083 &lt;limit&gt;
1084 </dt>
1085 <dd>
1087 An integer parameter specifies a cut-off percent (3% by default).
1088 Directories contributing less than this percentage of the changes
1089 are not shown in the output.
1090 </p>
1091 </dd>
1092 </dl></div>
1093 </div></div>
1094 <div class="paragraph"><p>Example: The following will count changed files, while ignoring
1095 directories with less than 10% of the total amount of changed files,
1096 and accumulating child directory counts in the parent directories:
1097 <code>--dirstat=files,10,cumulative</code>.</p></div>
1098 </dd>
1099 <dt class="hdlist1">
1100 --cumulative
1101 </dt>
1102 <dd>
1104 Synonym for --dirstat=cumulative
1105 </p>
1106 </dd>
1107 <dt class="hdlist1">
1108 --dirstat-by-file[=&lt;param1,param2&gt;&#8230;]
1109 </dt>
1110 <dd>
1112 Synonym for --dirstat=files,&lt;param1&gt;,&lt;param2&gt;&#8230;
1113 </p>
1114 </dd>
1115 <dt class="hdlist1">
1116 --summary
1117 </dt>
1118 <dd>
1120 Output a condensed summary of extended header information
1121 such as creations, renames and mode changes.
1122 </p>
1123 </dd>
1124 <dt class="hdlist1">
1125 --patch-with-stat
1126 </dt>
1127 <dd>
1129 Synonym for <code>-p --stat</code>.
1130 </p>
1131 </dd>
1132 <dt class="hdlist1">
1134 </dt>
1135 <dd>
1137 When <code>--raw</code>, <code>--numstat</code>, <code>--name-only</code> or <code>--name-status</code> has been
1138 given, do not munge pathnames and use NULs as output field terminators.
1139 </p>
1140 <div class="paragraph"><p>Without this option, pathnames with "unusual" characters are quoted as
1141 explained for the configuration variable <code>core.quotePath</code> (see
1142 <a href="git-config.html">git-config(1)</a>).</p></div>
1143 </dd>
1144 <dt class="hdlist1">
1145 --name-only
1146 </dt>
1147 <dd>
1149 Show only names of changed files. The file names are often encoded in UTF-8.
1150 For more information see the discussion about encoding in the <a href="git-log.html">git-log(1)</a>
1151 manual page.
1152 </p>
1153 </dd>
1154 <dt class="hdlist1">
1155 --name-status
1156 </dt>
1157 <dd>
1159 Show only names and status of changed files. See the description
1160 of the <code>--diff-filter</code> option on what the status letters mean.
1161 Just like <code>--name-only</code> the file names are often encoded in UTF-8.
1162 </p>
1163 </dd>
1164 <dt class="hdlist1">
1165 --submodule[=&lt;format&gt;]
1166 </dt>
1167 <dd>
1169 Specify how differences in submodules are shown. When specifying
1170 <code>--submodule=short</code> the <em>short</em> format is used. This format just
1171 shows the names of the commits at the beginning and end of the range.
1172 When <code>--submodule</code> or <code>--submodule=log</code> is specified, the <em>log</em>
1173 format is used. This format lists the commits in the range like
1174 <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code> does. When <code>--submodule=diff</code>
1175 is specified, the <em>diff</em> format is used. This format shows an
1176 inline diff of the changes in the submodule contents between the
1177 commit range. Defaults to <code>diff.submodule</code> or the <em>short</em> format
1178 if the config option is unset.
1179 </p>
1180 </dd>
1181 <dt class="hdlist1">
1182 --color[=&lt;when&gt;]
1183 </dt>
1184 <dd>
1186 Show colored diff.
1187 <code>--color</code> (i.e. without <em>=&lt;when&gt;</em>) is the same as <code>--color=always</code>.
1188 <em>&lt;when&gt;</em> can be one of <code>always</code>, <code>never</code>, or <code>auto</code>.
1189 </p>
1190 </dd>
1191 <dt class="hdlist1">
1192 --no-color
1193 </dt>
1194 <dd>
1196 Turn off colored diff.
1197 It is the same as <code>--color=never</code>.
1198 </p>
1199 </dd>
1200 <dt class="hdlist1">
1201 --color-moved[=&lt;mode&gt;]
1202 </dt>
1203 <dd>
1205 Moved lines of code are colored differently.
1206 The &lt;mode&gt; defaults to <em>no</em> if the option is not given
1207 and to <em>zebra</em> if the option with no mode is given.
1208 The mode must be one of:
1209 </p>
1210 <div class="openblock">
1211 <div class="content">
1212 <div class="dlist"><dl>
1213 <dt class="hdlist1">
1215 </dt>
1216 <dd>
1218 Moved lines are not highlighted.
1219 </p>
1220 </dd>
1221 <dt class="hdlist1">
1222 default
1223 </dt>
1224 <dd>
1226 Is a synonym for <code>zebra</code>. This may change to a more sensible mode
1227 in the future.
1228 </p>
1229 </dd>
1230 <dt class="hdlist1">
1231 plain
1232 </dt>
1233 <dd>
1235 Any line that is added in one location and was removed
1236 in another location will be colored with <em>color.diff.newMoved</em>.
1237 Similarly <em>color.diff.oldMoved</em> will be used for removed lines
1238 that are added somewhere else in the diff. This mode picks up any
1239 moved line, but it is not very useful in a review to determine
1240 if a block of code was moved without permutation.
1241 </p>
1242 </dd>
1243 <dt class="hdlist1">
1244 blocks
1245 </dt>
1246 <dd>
1248 Blocks of moved text of at least 20 alphanumeric characters
1249 are detected greedily. The detected blocks are
1250 painted using either the <em>color.diff.{old,new}Moved</em> color.
1251 Adjacent blocks cannot be told apart.
1252 </p>
1253 </dd>
1254 <dt class="hdlist1">
1255 zebra
1256 </dt>
1257 <dd>
1259 Blocks of moved text are detected as in <em>blocks</em> mode. The blocks
1260 are painted using either the <em>color.diff.{old,new}Moved</em> color or
1261 <em>color.diff.{old,new}MovedAlternative</em>. The change between
1262 the two colors indicates that a new block was detected.
1263 </p>
1264 </dd>
1265 <dt class="hdlist1">
1266 dimmed-zebra
1267 </dt>
1268 <dd>
1270 Similar to <em>zebra</em>, but additional dimming of uninteresting parts
1271 of moved code is performed. The bordering lines of two adjacent
1272 blocks are considered interesting, the rest is uninteresting.
1273 <code>dimmed_zebra</code> is a deprecated synonym.
1274 </p>
1275 </dd>
1276 </dl></div>
1277 </div></div>
1278 </dd>
1279 <dt class="hdlist1">
1280 --no-color-moved
1281 </dt>
1282 <dd>
1284 Turn off move detection. This can be used to override configuration
1285 settings. It is the same as <code>--color-moved=no</code>.
1286 </p>
1287 </dd>
1288 <dt class="hdlist1">
1289 --color-moved-ws=&lt;modes&gt;
1290 </dt>
1291 <dd>
1293 This configures how whitespace is ignored when performing the
1294 move detection for <code>--color-moved</code>.
1295 These modes can be given as a comma separated list:
1296 </p>
1297 <div class="openblock">
1298 <div class="content">
1299 <div class="dlist"><dl>
1300 <dt class="hdlist1">
1302 </dt>
1303 <dd>
1305 Do not ignore whitespace when performing move detection.
1306 </p>
1307 </dd>
1308 <dt class="hdlist1">
1309 ignore-space-at-eol
1310 </dt>
1311 <dd>
1313 Ignore changes in whitespace at EOL.
1314 </p>
1315 </dd>
1316 <dt class="hdlist1">
1317 ignore-space-change
1318 </dt>
1319 <dd>
1321 Ignore changes in amount of whitespace. This ignores whitespace
1322 at line end, and considers all other sequences of one or
1323 more whitespace characters to be equivalent.
1324 </p>
1325 </dd>
1326 <dt class="hdlist1">
1327 ignore-all-space
1328 </dt>
1329 <dd>
1331 Ignore whitespace when comparing lines. This ignores differences
1332 even if one line has whitespace where the other line has none.
1333 </p>
1334 </dd>
1335 <dt class="hdlist1">
1336 allow-indentation-change
1337 </dt>
1338 <dd>
1340 Initially ignore any whitespace in the move detection, then
1341 group the moved code blocks only into a block if the change in
1342 whitespace is the same per line. This is incompatible with the
1343 other modes.
1344 </p>
1345 </dd>
1346 </dl></div>
1347 </div></div>
1348 </dd>
1349 <dt class="hdlist1">
1350 --no-color-moved-ws
1351 </dt>
1352 <dd>
1354 Do not ignore whitespace when performing move detection. This can be
1355 used to override configuration settings. It is the same as
1356 <code>--color-moved-ws=no</code>.
1357 </p>
1358 </dd>
1359 <dt class="hdlist1">
1360 --word-diff[=&lt;mode&gt;]
1361 </dt>
1362 <dd>
1364 Show a word diff, using the &lt;mode&gt; to delimit changed words.
1365 By default, words are delimited by whitespace; see
1366 <code>--word-diff-regex</code> below. The &lt;mode&gt; defaults to <em>plain</em>, and
1367 must be one of:
1368 </p>
1369 <div class="openblock">
1370 <div class="content">
1371 <div class="dlist"><dl>
1372 <dt class="hdlist1">
1373 color
1374 </dt>
1375 <dd>
1377 Highlight changed words using only colors. Implies <code>--color</code>.
1378 </p>
1379 </dd>
1380 <dt class="hdlist1">
1381 plain
1382 </dt>
1383 <dd>
1385 Show words as <code>[-removed-]</code> and <code>{+added+}</code>. Makes no
1386 attempts to escape the delimiters if they appear in the input,
1387 so the output may be ambiguous.
1388 </p>
1389 </dd>
1390 <dt class="hdlist1">
1391 porcelain
1392 </dt>
1393 <dd>
1395 Use a special line-based format intended for script
1396 consumption. Added/removed/unchanged runs are printed in the
1397 usual unified diff format, starting with a <code>+</code>/<code>-</code>/` `
1398 character at the beginning of the line and extending to the
1399 end of the line. Newlines in the input are represented by a
1400 tilde <code>~</code> on a line of its own.
1401 </p>
1402 </dd>
1403 <dt class="hdlist1">
1404 none
1405 </dt>
1406 <dd>
1408 Disable word diff again.
1409 </p>
1410 </dd>
1411 </dl></div>
1412 </div></div>
1413 <div class="paragraph"><p>Note that despite the name of the first mode, color is used to
1414 highlight the changed parts in all modes if enabled.</p></div>
1415 </dd>
1416 <dt class="hdlist1">
1417 --word-diff-regex=&lt;regex&gt;
1418 </dt>
1419 <dd>
1421 Use &lt;regex&gt; to decide what a word is, instead of considering
1422 runs of non-whitespace to be a word. Also implies
1423 <code>--word-diff</code> unless it was already enabled.
1424 </p>
1425 <div class="paragraph"><p>Every non-overlapping match of the
1426 &lt;regex&gt; is considered a word. Anything between these matches is
1427 considered whitespace and ignored(!) for the purposes of finding
1428 differences. You may want to append <code>|[^[:space:]]</code> to your regular
1429 expression to make sure that it matches all non-whitespace characters.
1430 A match that contains a newline is silently truncated(!) at the
1431 newline.</p></div>
1432 <div class="paragraph"><p>For example, <code>--word-diff-regex=.</code> will treat each character as a word
1433 and, correspondingly, show differences character by character.</p></div>
1434 <div class="paragraph"><p>The regex can also be set via a diff driver or configuration option, see
1435 <a href="gitattributes.html">gitattributes(5)</a> or <a href="git-config.html">git-config(1)</a>. Giving it explicitly
1436 overrides any diff driver or configuration setting. Diff drivers
1437 override configuration settings.</p></div>
1438 </dd>
1439 <dt class="hdlist1">
1440 --color-words[=&lt;regex&gt;]
1441 </dt>
1442 <dd>
1444 Equivalent to <code>--word-diff=color</code> plus (if a regex was
1445 specified) <code>--word-diff-regex=&lt;regex&gt;</code>.
1446 </p>
1447 </dd>
1448 <dt class="hdlist1">
1449 --no-renames
1450 </dt>
1451 <dd>
1453 Turn off rename detection, even when the configuration
1454 file gives the default to do so.
1455 </p>
1456 </dd>
1457 <dt class="hdlist1">
1458 --[no-]rename-empty
1459 </dt>
1460 <dd>
1462 Whether to use empty blobs as rename source.
1463 </p>
1464 </dd>
1465 <dt class="hdlist1">
1466 --check
1467 </dt>
1468 <dd>
1470 Warn if changes introduce conflict markers or whitespace errors.
1471 What are considered whitespace errors is controlled by <code>core.whitespace</code>
1472 configuration. By default, trailing whitespaces (including
1473 lines that consist solely of whitespaces) and a space character
1474 that is immediately followed by a tab character inside the
1475 initial indent of the line are considered whitespace errors.
1476 Exits with non-zero status if problems are found. Not compatible
1477 with --exit-code.
1478 </p>
1479 </dd>
1480 <dt class="hdlist1">
1481 --ws-error-highlight=&lt;kind&gt;
1482 </dt>
1483 <dd>
1485 Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
1486 lines of the diff. Multiple values are separated by comma,
1487 <code>none</code> resets previous values, <code>default</code> reset the list to
1488 <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>. When
1489 this option is not given, and the configuration variable
1490 <code>diff.wsErrorHighlight</code> is not set, only whitespace errors in
1491 <code>new</code> lines are highlighted. The whitespace errors are colored
1492 with <code>color.diff.whitespace</code>.
1493 </p>
1494 </dd>
1495 <dt class="hdlist1">
1496 --full-index
1497 </dt>
1498 <dd>
1500 Instead of the first handful of characters, show the full
1501 pre- and post-image blob object names on the "index"
1502 line when generating patch format output.
1503 </p>
1504 </dd>
1505 <dt class="hdlist1">
1506 --binary
1507 </dt>
1508 <dd>
1510 In addition to <code>--full-index</code>, output a binary diff that
1511 can be applied with <code>git-apply</code>.
1512 Implies <code>--patch</code>.
1513 </p>
1514 </dd>
1515 <dt class="hdlist1">
1516 --abbrev[=&lt;n&gt;]
1517 </dt>
1518 <dd>
1520 Instead of showing the full 40-byte hexadecimal object
1521 name in diff-raw format output and diff-tree header
1522 lines, show the shortest prefix that is at least <em>&lt;n&gt;</em>
1523 hexdigits long that uniquely refers the object.
1524 In diff-patch output format, <code>--full-index</code> takes higher
1525 precedence, i.e. if <code>--full-index</code> is specified, full blob
1526 names will be shown regardless of <code>--abbrev</code>.
1527 Non default number of digits can be specified with <code>--abbrev=&lt;n&gt;</code>.
1528 </p>
1529 </dd>
1530 <dt class="hdlist1">
1531 -B[&lt;n&gt;][/&lt;m&gt;]
1532 </dt>
1533 <dt class="hdlist1">
1534 --break-rewrites[=[&lt;n&gt;][/&lt;m&gt;]]
1535 </dt>
1536 <dd>
1538 Break complete rewrite changes into pairs of delete and
1539 create. This serves two purposes:
1540 </p>
1541 <div class="paragraph"><p>It affects the way a change that amounts to a total rewrite of a file
1542 not as a series of deletion and insertion mixed together with a very
1543 few lines that happen to match textually as the context, but as a
1544 single deletion of everything old followed by a single insertion of
1545 everything new, and the number <code>m</code> controls this aspect of the -B
1546 option (defaults to 60%). <code>-B/70%</code> specifies that less than 30% of the
1547 original should remain in the result for Git to consider it a total
1548 rewrite (i.e. otherwise the resulting patch will be a series of
1549 deletion and insertion mixed together with context lines).</p></div>
1550 <div class="paragraph"><p>When used with -M, a totally-rewritten file is also considered as the
1551 source of a rename (usually -M only considers a file that disappeared
1552 as the source of a rename), and the number <code>n</code> controls this aspect of
1553 the -B option (defaults to 50%). <code>-B20%</code> specifies that a change with
1554 addition and deletion compared to 20% or more of the file&#8217;s size are
1555 eligible for being picked up as a possible source of a rename to
1556 another file.</p></div>
1557 </dd>
1558 <dt class="hdlist1">
1559 -M[&lt;n&gt;]
1560 </dt>
1561 <dt class="hdlist1">
1562 --find-renames[=&lt;n&gt;]
1563 </dt>
1564 <dd>
1566 Detect renames.
1567 If <code>n</code> is specified, it is a threshold on the similarity
1568 index (i.e. amount of addition/deletions compared to the
1569 file&#8217;s size). For example, <code>-M90%</code> means Git should consider a
1570 delete/add pair to be a rename if more than 90% of the file
1571 hasn&#8217;t changed. Without a <code>%</code> sign, the number is to be read as
1572 a fraction, with a decimal point before it. I.e., <code>-M5</code> becomes
1573 0.5, and is thus the same as <code>-M50%</code>. Similarly, <code>-M05</code> is
1574 the same as <code>-M5%</code>. To limit detection to exact renames, use
1575 <code>-M100%</code>. The default similarity index is 50%.
1576 </p>
1577 </dd>
1578 <dt class="hdlist1">
1579 -C[&lt;n&gt;]
1580 </dt>
1581 <dt class="hdlist1">
1582 --find-copies[=&lt;n&gt;]
1583 </dt>
1584 <dd>
1586 Detect copies as well as renames. See also <code>--find-copies-harder</code>.
1587 If <code>n</code> is specified, it has the same meaning as for <code>-M&lt;n&gt;</code>.
1588 </p>
1589 </dd>
1590 <dt class="hdlist1">
1591 --find-copies-harder
1592 </dt>
1593 <dd>
1595 For performance reasons, by default, <code>-C</code> option finds copies only
1596 if the original file of the copy was modified in the same
1597 changeset. This flag makes the command
1598 inspect unmodified files as candidates for the source of
1599 copy. This is a very expensive operation for large
1600 projects, so use it with caution. Giving more than one
1601 <code>-C</code> option has the same effect.
1602 </p>
1603 </dd>
1604 <dt class="hdlist1">
1606 </dt>
1607 <dt class="hdlist1">
1608 --irreversible-delete
1609 </dt>
1610 <dd>
1612 Omit the preimage for deletes, i.e. print only the header but not
1613 the diff between the preimage and <code>/dev/null</code>. The resulting patch
1614 is not meant to be applied with <code>patch</code> or <code>git apply</code>; this is
1615 solely for people who want to just concentrate on reviewing the
1616 text after the change. In addition, the output obviously lacks
1617 enough information to apply such a patch in reverse, even manually,
1618 hence the name of the option.
1619 </p>
1620 <div class="paragraph"><p>When used together with <code>-B</code>, omit also the preimage in the deletion part
1621 of a delete/create pair.</p></div>
1622 </dd>
1623 <dt class="hdlist1">
1624 -l&lt;num&gt;
1625 </dt>
1626 <dd>
1628 The <code>-M</code> and <code>-C</code> options involve some preliminary steps that
1629 can detect subsets of renames/copies cheaply, followed by an
1630 exhaustive fallback portion that compares all remaining
1631 unpaired destinations to all relevant sources. (For renames,
1632 only remaining unpaired sources are relevant; for copies, all
1633 original sources are relevant.) For N sources and
1634 destinations, this exhaustive check is O(N^2). This option
1635 prevents the exhaustive portion of rename/copy detection from
1636 running if the number of source/destination files involved
1637 exceeds the specified number. Defaults to diff.renameLimit.
1638 Note that a value of 0 is treated as unlimited.
1639 </p>
1640 </dd>
1641 <dt class="hdlist1">
1642 --diff-filter=[(A|C|D|M|R|T|U|X|B)&#8230;[*]]
1643 </dt>
1644 <dd>
1646 Select only files that are Added (<code>A</code>), Copied (<code>C</code>),
1647 Deleted (<code>D</code>), Modified (<code>M</code>), Renamed (<code>R</code>), have their
1648 type (i.e. regular file, symlink, submodule, &#8230;) changed (<code>T</code>),
1649 are Unmerged (<code>U</code>), are
1650 Unknown (<code>X</code>), or have had their pairing Broken (<code>B</code>).
1651 Any combination of the filter characters (including none) can be used.
1652 When <code>*</code> (All-or-none) is added to the combination, all
1653 paths are selected if there is any file that matches
1654 other criteria in the comparison; if there is no file
1655 that matches other criteria, nothing is selected.
1656 </p>
1657 <div class="paragraph"><p>Also, these upper-case letters can be downcased to exclude. E.g.
1658 <code>--diff-filter=ad</code> excludes added and deleted paths.</p></div>
1659 <div class="paragraph"><p>Note that not all diffs can feature all types. For instance, copied and
1660 renamed entries cannot appear if detection for those types is disabled.</p></div>
1661 </dd>
1662 <dt class="hdlist1">
1663 -S&lt;string&gt;
1664 </dt>
1665 <dd>
1667 Look for differences that change the number of occurrences of
1668 the specified string (i.e. addition/deletion) in a file.
1669 Intended for the scripter&#8217;s use.
1670 </p>
1671 <div class="paragraph"><p>It is useful when you&#8217;re looking for an exact block of code (like a
1672 struct), and want to know the history of that block since it first
1673 came into being: use the feature iteratively to feed the interesting
1674 block in the preimage back into <code>-S</code>, and keep going until you get the
1675 very first version of the block.</p></div>
1676 <div class="paragraph"><p>Binary files are searched as well.</p></div>
1677 </dd>
1678 <dt class="hdlist1">
1679 -G&lt;regex&gt;
1680 </dt>
1681 <dd>
1683 Look for differences whose patch text contains added/removed
1684 lines that match &lt;regex&gt;.
1685 </p>
1686 <div class="paragraph"><p>To illustrate the difference between <code>-S&lt;regex&gt; --pickaxe-regex</code> and
1687 <code>-G&lt;regex&gt;</code>, consider a commit with the following diff in the same
1688 file:</p></div>
1689 <div class="listingblock">
1690 <div class="content">
1691 <pre><code>+ return frotz(nitfol, two-&gt;ptr, 1, 0);
1693 - hit = frotz(nitfol, mf2.ptr, 1, 0);</code></pre>
1694 </div></div>
1695 <div class="paragraph"><p>While <code>git log -G"frotz\(nitfol"</code> will show this commit, <code>git log
1696 -S"frotz\(nitfol" --pickaxe-regex</code> will not (because the number of
1697 occurrences of that string did not change).</p></div>
1698 <div class="paragraph"><p>Unless <code>--text</code> is supplied patches of binary files without a textconv
1699 filter will be ignored.</p></div>
1700 <div class="paragraph"><p>See the <em>pickaxe</em> entry in <a href="gitdiffcore.html">gitdiffcore(7)</a> for more
1701 information.</p></div>
1702 </dd>
1703 <dt class="hdlist1">
1704 --find-object=&lt;object-id&gt;
1705 </dt>
1706 <dd>
1708 Look for differences that change the number of occurrences of
1709 the specified object. Similar to <code>-S</code>, just the argument is different
1710 in that it doesn&#8217;t search for a specific string but for a specific
1711 object id.
1712 </p>
1713 <div class="paragraph"><p>The object can be a blob or a submodule commit. It implies the <code>-t</code> option in
1714 <code>git-log</code> to also find trees.</p></div>
1715 </dd>
1716 <dt class="hdlist1">
1717 --pickaxe-all
1718 </dt>
1719 <dd>
1721 When <code>-S</code> or <code>-G</code> finds a change, show all the changes in that
1722 changeset, not just the files that contain the change
1723 in &lt;string&gt;.
1724 </p>
1725 </dd>
1726 <dt class="hdlist1">
1727 --pickaxe-regex
1728 </dt>
1729 <dd>
1731 Treat the &lt;string&gt; given to <code>-S</code> as an extended POSIX regular
1732 expression to match.
1733 </p>
1734 </dd>
1735 <dt class="hdlist1">
1736 -O&lt;orderfile&gt;
1737 </dt>
1738 <dd>
1740 Control the order in which files appear in the output.
1741 This overrides the <code>diff.orderFile</code> configuration variable
1742 (see <a href="git-config.html">git-config(1)</a>). To cancel <code>diff.orderFile</code>,
1743 use <code>-O/dev/null</code>.
1744 </p>
1745 <div class="paragraph"><p>The output order is determined by the order of glob patterns in
1746 &lt;orderfile&gt;.
1747 All files with pathnames that match the first pattern are output
1748 first, all files with pathnames that match the second pattern (but not
1749 the first) are output next, and so on.
1750 All files with pathnames that do not match any pattern are output
1751 last, as if there was an implicit match-all pattern at the end of the
1752 file.
1753 If multiple pathnames have the same rank (they match the same pattern
1754 but no earlier patterns), their output order relative to each other is
1755 the normal order.</p></div>
1756 <div class="paragraph"><p>&lt;orderfile&gt; is parsed as follows:</p></div>
1757 <div class="openblock">
1758 <div class="content">
1759 <div class="ulist"><ul>
1760 <li>
1762 Blank lines are ignored, so they can be used as separators for
1763 readability.
1764 </p>
1765 </li>
1766 <li>
1768 Lines starting with a hash ("<code>#</code>") are ignored, so they can be used
1769 for comments. Add a backslash ("<code>\</code>") to the beginning of the
1770 pattern if it starts with a hash.
1771 </p>
1772 </li>
1773 <li>
1775 Each other line contains a single pattern.
1776 </p>
1777 </li>
1778 </ul></div>
1779 </div></div>
1780 <div class="paragraph"><p>Patterns have the same syntax and semantics as patterns used for
1781 fnmatch(3) without the FNM_PATHNAME flag, except a pathname also
1782 matches a pattern if removing any number of the final pathname
1783 components matches the pattern. For example, the pattern "<code>foo*bar</code>"
1784 matches "<code>fooasdfbar</code>" and "<code>foo/bar/baz/asdf</code>" but not "<code>foobarx</code>".</p></div>
1785 </dd>
1786 <dt class="hdlist1">
1787 --skip-to=&lt;file&gt;
1788 </dt>
1789 <dt class="hdlist1">
1790 --rotate-to=&lt;file&gt;
1791 </dt>
1792 <dd>
1794 Discard the files before the named &lt;file&gt; from the output
1795 (i.e. <em>skip to</em>), or move them to the end of the output
1796 (i.e. <em>rotate to</em>). These options were invented primarily for the use
1797 of the <code>git difftool</code> command, and may not be very useful
1798 otherwise.
1799 </p>
1800 </dd>
1801 <dt class="hdlist1">
1803 </dt>
1804 <dd>
1806 Swap two inputs; that is, show differences from index or
1807 on-disk file to tree contents.
1808 </p>
1809 </dd>
1810 <dt class="hdlist1">
1811 --relative[=&lt;path&gt;]
1812 </dt>
1813 <dt class="hdlist1">
1814 --no-relative
1815 </dt>
1816 <dd>
1818 When run from a subdirectory of the project, it can be
1819 told to exclude changes outside the directory and show
1820 pathnames relative to it with this option. When you are
1821 not in a subdirectory (e.g. in a bare repository), you
1822 can name which subdirectory to make the output relative
1823 to by giving a &lt;path&gt; as an argument.
1824 <code>--no-relative</code> can be used to countermand both <code>diff.relative</code> config
1825 option and previous <code>--relative</code>.
1826 </p>
1827 </dd>
1828 <dt class="hdlist1">
1830 </dt>
1831 <dt class="hdlist1">
1832 --text
1833 </dt>
1834 <dd>
1836 Treat all files as text.
1837 </p>
1838 </dd>
1839 <dt class="hdlist1">
1840 --ignore-cr-at-eol
1841 </dt>
1842 <dd>
1844 Ignore carriage-return at the end of line when doing a comparison.
1845 </p>
1846 </dd>
1847 <dt class="hdlist1">
1848 --ignore-space-at-eol
1849 </dt>
1850 <dd>
1852 Ignore changes in whitespace at EOL.
1853 </p>
1854 </dd>
1855 <dt class="hdlist1">
1857 </dt>
1858 <dt class="hdlist1">
1859 --ignore-space-change
1860 </dt>
1861 <dd>
1863 Ignore changes in amount of whitespace. This ignores whitespace
1864 at line end, and considers all other sequences of one or
1865 more whitespace characters to be equivalent.
1866 </p>
1867 </dd>
1868 <dt class="hdlist1">
1870 </dt>
1871 <dt class="hdlist1">
1872 --ignore-all-space
1873 </dt>
1874 <dd>
1876 Ignore whitespace when comparing lines. This ignores
1877 differences even if one line has whitespace where the other
1878 line has none.
1879 </p>
1880 </dd>
1881 <dt class="hdlist1">
1882 --ignore-blank-lines
1883 </dt>
1884 <dd>
1886 Ignore changes whose lines are all blank.
1887 </p>
1888 </dd>
1889 <dt class="hdlist1">
1890 -I&lt;regex&gt;
1891 </dt>
1892 <dt class="hdlist1">
1893 --ignore-matching-lines=&lt;regex&gt;
1894 </dt>
1895 <dd>
1897 Ignore changes whose all lines match &lt;regex&gt;. This option may
1898 be specified more than once.
1899 </p>
1900 </dd>
1901 <dt class="hdlist1">
1902 --inter-hunk-context=&lt;lines&gt;
1903 </dt>
1904 <dd>
1906 Show the context between diff hunks, up to the specified number
1907 of lines, thereby fusing hunks that are close to each other.
1908 Defaults to <code>diff.interHunkContext</code> or 0 if the config option
1909 is unset.
1910 </p>
1911 </dd>
1912 <dt class="hdlist1">
1914 </dt>
1915 <dt class="hdlist1">
1916 --function-context
1917 </dt>
1918 <dd>
1920 Show whole function as context lines for each change.
1921 The function names are determined in the same way as
1922 <code>git diff</code> works out patch hunk headers (see <em>Defining a
1923 custom hunk-header</em> in <a href="gitattributes.html">gitattributes(5)</a>).
1924 </p>
1925 </dd>
1926 <dt class="hdlist1">
1927 --exit-code
1928 </dt>
1929 <dd>
1931 Make the program exit with codes similar to diff(1).
1932 That is, it exits with 1 if there were differences and
1933 0 means no differences.
1934 </p>
1935 </dd>
1936 <dt class="hdlist1">
1937 --quiet
1938 </dt>
1939 <dd>
1941 Disable all output of the program. Implies <code>--exit-code</code>.
1942 </p>
1943 </dd>
1944 <dt class="hdlist1">
1945 --ext-diff
1946 </dt>
1947 <dd>
1949 Allow an external diff helper to be executed. If you set an
1950 external diff driver with <a href="gitattributes.html">gitattributes(5)</a>, you need
1951 to use this option with <a href="git-log.html">git-log(1)</a> and friends.
1952 </p>
1953 </dd>
1954 <dt class="hdlist1">
1955 --no-ext-diff
1956 </dt>
1957 <dd>
1959 Disallow external diff drivers.
1960 </p>
1961 </dd>
1962 <dt class="hdlist1">
1963 --textconv
1964 </dt>
1965 <dt class="hdlist1">
1966 --no-textconv
1967 </dt>
1968 <dd>
1970 Allow (or disallow) external text conversion filters to be run
1971 when comparing binary files. See <a href="gitattributes.html">gitattributes(5)</a> for
1972 details. Because textconv filters are typically a one-way
1973 conversion, the resulting diff is suitable for human
1974 consumption, but cannot be applied. For this reason, textconv
1975 filters are enabled by default only for <a href="git-diff.html">git-diff(1)</a> and
1976 <a href="git-log.html">git-log(1)</a>, but not for <a href="git-format-patch.html">git-format-patch(1)</a> or
1977 diff plumbing commands.
1978 </p>
1979 </dd>
1980 <dt class="hdlist1">
1981 --ignore-submodules[=&lt;when&gt;]
1982 </dt>
1983 <dd>
1985 Ignore changes to submodules in the diff generation. &lt;when&gt; can be
1986 either "none", "untracked", "dirty" or "all", which is the default.
1987 Using "none" will consider the submodule modified when it either contains
1988 untracked or modified files or its HEAD differs from the commit recorded
1989 in the superproject and can be used to override any settings of the
1990 <em>ignore</em> option in <a href="git-config.html">git-config(1)</a> or <a href="gitmodules.html">gitmodules(5)</a>. When
1991 "untracked" is used submodules are not considered dirty when they only
1992 contain untracked content (but they are still scanned for modified
1993 content). Using "dirty" ignores all changes to the work tree of submodules,
1994 only changes to the commits stored in the superproject are shown (this was
1995 the behavior until 1.7.0). Using "all" hides all changes to submodules.
1996 </p>
1997 </dd>
1998 <dt class="hdlist1">
1999 --src-prefix=&lt;prefix&gt;
2000 </dt>
2001 <dd>
2003 Show the given source prefix instead of "a/".
2004 </p>
2005 </dd>
2006 <dt class="hdlist1">
2007 --dst-prefix=&lt;prefix&gt;
2008 </dt>
2009 <dd>
2011 Show the given destination prefix instead of "b/".
2012 </p>
2013 </dd>
2014 <dt class="hdlist1">
2015 --no-prefix
2016 </dt>
2017 <dd>
2019 Do not show any source or destination prefix.
2020 </p>
2021 </dd>
2022 <dt class="hdlist1">
2023 --default-prefix
2024 </dt>
2025 <dd>
2027 Use the default source and destination prefixes ("a/" and "b/").
2028 This overrides configuration variables such as <code>diff.noprefix</code>,
2029 <code>diff.srcPrefix</code>, <code>diff.dstPrefix</code>, and <code>diff.mnemonicPrefix</code>
2030 (see <code>git-config</code>(1)).
2031 </p>
2032 </dd>
2033 <dt class="hdlist1">
2034 --line-prefix=&lt;prefix&gt;
2035 </dt>
2036 <dd>
2038 Prepend an additional prefix to every line of output.
2039 </p>
2040 </dd>
2041 <dt class="hdlist1">
2042 --ita-invisible-in-index
2043 </dt>
2044 <dd>
2046 By default entries added by "git add -N" appear as an existing
2047 empty file in "git diff" and a new file in "git diff --cached".
2048 This option makes the entry appear as a new file in "git diff"
2049 and non-existent in "git diff --cached". This option could be
2050 reverted with <code>--ita-visible-in-index</code>. Both options are
2051 experimental and could be removed in future.
2052 </p>
2053 </dd>
2054 </dl></div>
2055 <div class="paragraph"><p>For more detailed explanation on these common options, see also
2056 <a href="gitdiffcore.html">gitdiffcore(7)</a>.</p></div>
2057 <div class="dlist"><dl>
2058 <dt class="hdlist1">
2059 &lt;tree-ish&gt;
2060 </dt>
2061 <dd>
2063 The id of a tree object to diff against.
2064 </p>
2065 </dd>
2066 <dt class="hdlist1">
2067 --cached
2068 </dt>
2069 <dd>
2071 Do not consider the on-disk file at all.
2072 </p>
2073 </dd>
2074 <dt class="hdlist1">
2075 --merge-base
2076 </dt>
2077 <dd>
2079 Instead of comparing &lt;tree-ish&gt; directly, use the merge base
2080 between &lt;tree-ish&gt; and HEAD instead. &lt;tree-ish&gt; must be a
2081 commit.
2082 </p>
2083 </dd>
2084 <dt class="hdlist1">
2086 </dt>
2087 <dd>
2089 By default, files recorded in the index but not checked
2090 out are reported as deleted. This flag makes
2091 <em>git diff-index</em> say that all non-checked-out files are up
2092 to date.
2093 </p>
2094 </dd>
2095 </dl></div>
2096 </div>
2097 </div>
2098 <div class="sect1">
2099 <h2 id="_raw_output_format">Raw output format</h2>
2100 <div class="sectionbody">
2101 <div class="paragraph"><p>The raw output format from "git-diff-index", "git-diff-tree",
2102 "git-diff-files" and "git diff --raw" are very similar.</p></div>
2103 <div class="paragraph"><p>These commands all compare two sets of things; what is
2104 compared differs:</p></div>
2105 <div class="dlist"><dl>
2106 <dt class="hdlist1">
2107 git-diff-index &lt;tree-ish&gt;
2108 </dt>
2109 <dd>
2111 compares the &lt;tree-ish&gt; and the files on the filesystem.
2112 </p>
2113 </dd>
2114 <dt class="hdlist1">
2115 git-diff-index --cached &lt;tree-ish&gt;
2116 </dt>
2117 <dd>
2119 compares the &lt;tree-ish&gt; and the index.
2120 </p>
2121 </dd>
2122 <dt class="hdlist1">
2123 git-diff-tree [-r] &lt;tree-ish-1&gt; &lt;tree-ish-2&gt; [&lt;pattern&gt;&#8230;]
2124 </dt>
2125 <dd>
2127 compares the trees named by the two arguments.
2128 </p>
2129 </dd>
2130 <dt class="hdlist1">
2131 git-diff-files [&lt;pattern&gt;&#8230;]
2132 </dt>
2133 <dd>
2135 compares the index and the files on the filesystem.
2136 </p>
2137 </dd>
2138 </dl></div>
2139 <div class="paragraph"><p>The "git-diff-tree" command begins its output by printing the hash of
2140 what is being compared. After that, all the commands print one output
2141 line per changed file.</p></div>
2142 <div class="paragraph"><p>An output line is formatted this way:</p></div>
2143 <div class="listingblock">
2144 <div class="content">
2145 <pre><code>in-place edit :100644 100644 bcd1234 0123456 M file0
2146 copy-edit :100644 100644 abcd123 1234567 C68 file1 file2
2147 rename-edit :100644 100644 abcd123 1234567 R86 file1 file3
2148 create :000000 100644 0000000 1234567 A file4
2149 delete :100644 000000 1234567 0000000 D file5
2150 unmerged :000000 000000 0000000 0000000 U file6</code></pre>
2151 </div></div>
2152 <div class="paragraph"><p>That is, from the left to the right:</p></div>
2153 <div class="olist arabic"><ol class="arabic">
2154 <li>
2156 a colon.
2157 </p>
2158 </li>
2159 <li>
2161 mode for "src"; 000000 if creation or unmerged.
2162 </p>
2163 </li>
2164 <li>
2166 a space.
2167 </p>
2168 </li>
2169 <li>
2171 mode for "dst"; 000000 if deletion or unmerged.
2172 </p>
2173 </li>
2174 <li>
2176 a space.
2177 </p>
2178 </li>
2179 <li>
2181 sha1 for "src"; 0{40} if creation or unmerged.
2182 </p>
2183 </li>
2184 <li>
2186 a space.
2187 </p>
2188 </li>
2189 <li>
2191 sha1 for "dst"; 0{40} if deletion, unmerged or "work tree out of sync with the index".
2192 </p>
2193 </li>
2194 <li>
2196 a space.
2197 </p>
2198 </li>
2199 <li>
2201 status, followed by optional "score" number.
2202 </p>
2203 </li>
2204 <li>
2206 a tab or a NUL when <code>-z</code> option is used.
2207 </p>
2208 </li>
2209 <li>
2211 path for "src"
2212 </p>
2213 </li>
2214 <li>
2216 a tab or a NUL when <code>-z</code> option is used; only exists for C or R.
2217 </p>
2218 </li>
2219 <li>
2221 path for "dst"; only exists for C or R.
2222 </p>
2223 </li>
2224 <li>
2226 an LF or a NUL when <code>-z</code> option is used, to terminate the record.
2227 </p>
2228 </li>
2229 </ol></div>
2230 <div class="paragraph"><p>Possible status letters are:</p></div>
2231 <div class="ulist"><ul>
2232 <li>
2234 A: addition of a file
2235 </p>
2236 </li>
2237 <li>
2239 C: copy of a file into a new one
2240 </p>
2241 </li>
2242 <li>
2244 D: deletion of a file
2245 </p>
2246 </li>
2247 <li>
2249 M: modification of the contents or mode of a file
2250 </p>
2251 </li>
2252 <li>
2254 R: renaming of a file
2255 </p>
2256 </li>
2257 <li>
2259 T: change in the type of the file (regular file, symbolic link or submodule)
2260 </p>
2261 </li>
2262 <li>
2264 U: file is unmerged (you must complete the merge before it can
2265 be committed)
2266 </p>
2267 </li>
2268 <li>
2270 X: "unknown" change type (most probably a bug, please report it)
2271 </p>
2272 </li>
2273 </ul></div>
2274 <div class="paragraph"><p>Status letters C and R are always followed by a score (denoting the
2275 percentage of similarity between the source and target of the move or
2276 copy). Status letter M may be followed by a score (denoting the
2277 percentage of dissimilarity) for file rewrites.</p></div>
2278 <div class="paragraph"><p>The sha1 for "dst" is shown as all 0&#8217;s if a file on the filesystem
2279 is out of sync with the index.</p></div>
2280 <div class="paragraph"><p>Example:</p></div>
2281 <div class="listingblock">
2282 <div class="content">
2283 <pre><code>:100644 100644 5be4a4a 0000000 M file.c</code></pre>
2284 </div></div>
2285 <div class="paragraph"><p>Without the <code>-z</code> option, pathnames with "unusual" characters are
2286 quoted as explained for the configuration variable <code>core.quotePath</code>
2287 (see <a href="git-config.html">git-config(1)</a>). Using <code>-z</code> the filename is output
2288 verbatim and the line is terminated by a NUL byte.</p></div>
2289 </div>
2290 </div>
2291 <div class="sect1">
2292 <h2 id="_diff_format_for_merges">diff format for merges</h2>
2293 <div class="sectionbody">
2294 <div class="paragraph"><p>"git-diff-tree", "git-diff-files" and "git-diff --raw"
2295 can take <code>-c</code> or <code>--cc</code> option
2296 to generate diff output also for merge commits. The output differs
2297 from the format described above in the following way:</p></div>
2298 <div class="olist arabic"><ol class="arabic">
2299 <li>
2301 there is a colon for each parent
2302 </p>
2303 </li>
2304 <li>
2306 there are more "src" modes and "src" sha1
2307 </p>
2308 </li>
2309 <li>
2311 status is concatenated status characters for each parent
2312 </p>
2313 </li>
2314 <li>
2316 no optional "score" number
2317 </p>
2318 </li>
2319 <li>
2321 tab-separated pathname(s) of the file
2322 </p>
2323 </li>
2324 </ol></div>
2325 <div class="paragraph"><p>For <code>-c</code> and <code>--cc</code>, only the destination or final path is shown even
2326 if the file was renamed on any side of history. With
2327 <code>--combined-all-paths</code>, the name of the path in each parent is shown
2328 followed by the name of the path in the merge commit.</p></div>
2329 <div class="paragraph"><p>Examples for <code>-c</code> and <code>--cc</code> without <code>--combined-all-paths</code>:</p></div>
2330 <div class="listingblock">
2331 <div class="content">
2332 <pre><code>::100644 100644 100644 fabadb8 cc95eb0 4866510 MM desc.c
2333 ::100755 100755 100755 52b7a2d 6d1ac04 d2ac7d7 RM bar.sh
2334 ::100644 100644 100644 e07d6c5 9042e82 ee91881 RR phooey.c</code></pre>
2335 </div></div>
2336 <div class="paragraph"><p>Examples when <code>--combined-all-paths</code> added to either <code>-c</code> or <code>--cc</code>:</p></div>
2337 <div class="listingblock">
2338 <div class="content">
2339 <pre><code>::100644 100644 100644 fabadb8 cc95eb0 4866510 MM desc.c desc.c desc.c
2340 ::100755 100755 100755 52b7a2d 6d1ac04 d2ac7d7 RM foo.sh bar.sh bar.sh
2341 ::100644 100644 100644 e07d6c5 9042e82 ee91881 RR fooey.c fuey.c phooey.c</code></pre>
2342 </div></div>
2343 <div class="paragraph"><p>Note that <em>combined diff</em> lists only files which were modified from
2344 all parents.</p></div>
2345 </div>
2346 </div>
2347 <div class="sect1">
2348 <h2 id="generate_patch_text_with_p">Generating patch text with -p</h2>
2349 <div class="sectionbody">
2350 <div class="paragraph"><p>Running
2351 <a href="git-diff.html">git-diff(1)</a>,
2352 <a href="git-log.html">git-log(1)</a>,
2353 <a href="git-show.html">git-show(1)</a>,
2354 <a href="git-diff-index.html">git-diff-index(1)</a>,
2355 <a href="git-diff-tree.html">git-diff-tree(1)</a>, or
2356 <a href="git-diff-files.html">git-diff-files(1)</a>
2357 with the <code>-p</code> option produces patch text.
2358 You can customize the creation of patch text via the
2359 <code>GIT_EXTERNAL_DIFF</code> and the <code>GIT_DIFF_OPTS</code> environment variables
2360 (see <a href="git.html">git(1)</a>), and the <code>diff</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).</p></div>
2361 <div class="paragraph"><p>What the -p option produces is slightly different from the traditional
2362 diff format:</p></div>
2363 <div class="olist arabic"><ol class="arabic">
2364 <li>
2366 It is preceded by a "git diff" header that looks like this:
2367 </p>
2368 <div class="literalblock">
2369 <div class="content">
2370 <pre><code>diff --git a/file1 b/file2</code></pre>
2371 </div></div>
2372 <div class="paragraph"><p>The <code>a/</code> and <code>b/</code> filenames are the same unless rename/copy is
2373 involved. Especially, even for a creation or a deletion,
2374 <code>/dev/null</code> is <em>not</em> used in place of the <code>a/</code> or <code>b/</code> filenames.</p></div>
2375 <div class="paragraph"><p>When a rename/copy is involved, <code>file1</code> and <code>file2</code> show the
2376 name of the source file of the rename/copy and the name of
2377 the file that the rename/copy produces, respectively.</p></div>
2378 </li>
2379 <li>
2381 It is followed by one or more extended header lines:
2382 </p>
2383 <div class="literalblock">
2384 <div class="content">
2385 <pre><code>old mode &lt;mode&gt;
2386 new mode &lt;mode&gt;
2387 deleted file mode &lt;mode&gt;
2388 new file mode &lt;mode&gt;
2389 copy from &lt;path&gt;
2390 copy to &lt;path&gt;
2391 rename from &lt;path&gt;
2392 rename to &lt;path&gt;
2393 similarity index &lt;number&gt;
2394 dissimilarity index &lt;number&gt;
2395 index &lt;hash&gt;..&lt;hash&gt; &lt;mode&gt;</code></pre>
2396 </div></div>
2397 <div class="paragraph"><p>File modes are printed as 6-digit octal numbers including the file type
2398 and file permission bits.</p></div>
2399 <div class="paragraph"><p>Path names in extended headers do not include the <code>a/</code> and <code>b/</code> prefixes.</p></div>
2400 <div class="paragraph"><p>The similarity index is the percentage of unchanged lines, and
2401 the dissimilarity index is the percentage of changed lines. It
2402 is a rounded down integer, followed by a percent sign. The
2403 similarity index value of 100% is thus reserved for two equal
2404 files, while 100% dissimilarity means that no line from the old
2405 file made it into the new one.</p></div>
2406 <div class="paragraph"><p>The index line includes the blob object names before and after the change.
2407 The &lt;mode&gt; is included if the file mode does not change; otherwise,
2408 separate lines indicate the old and the new mode.</p></div>
2409 </li>
2410 <li>
2412 Pathnames with "unusual" characters are quoted as explained for
2413 the configuration variable <code>core.quotePath</code> (see
2414 <a href="git-config.html">git-config(1)</a>).
2415 </p>
2416 </li>
2417 <li>
2419 All the <code>file1</code> files in the output refer to files before the
2420 commit, and all the <code>file2</code> files refer to files after the commit.
2421 It is incorrect to apply each change to each file sequentially. For
2422 example, this patch will swap a and b:
2423 </p>
2424 <div class="literalblock">
2425 <div class="content">
2426 <pre><code>diff --git a/a b/b
2427 rename from a
2428 rename to b
2429 diff --git a/b b/a
2430 rename from b
2431 rename to a</code></pre>
2432 </div></div>
2433 </li>
2434 <li>
2436 Hunk headers mention the name of the function to which the hunk
2437 applies. See "Defining a custom hunk-header" in
2438 <a href="gitattributes.html">gitattributes(5)</a> for details of how to tailor this to
2439 specific languages.
2440 </p>
2441 </li>
2442 </ol></div>
2443 </div>
2444 </div>
2445 <div class="sect1">
2446 <h2 id="_combined_diff_format">Combined diff format</h2>
2447 <div class="sectionbody">
2448 <div class="paragraph"><p>Any diff-generating command can take the <code>-c</code> or <code>--cc</code> option to
2449 produce a <em>combined diff</em> when showing a merge. This is the default
2450 format when showing merges with <a href="git-diff.html">git-diff(1)</a> or
2451 <a href="git-show.html">git-show(1)</a>. Note also that you can give suitable
2452 <code>--diff-merges</code> option to any of these commands to force generation of
2453 diffs in a specific format.</p></div>
2454 <div class="paragraph"><p>A "combined diff" format looks like this:</p></div>
2455 <div class="listingblock">
2456 <div class="content">
2457 <pre><code>diff --combined describe.c
2458 index fabadb8,cc95eb0..4866510
2459 --- a/describe.c
2460 +++ b/describe.c
2461 @@@ -98,20 -98,12 +98,20 @@@
2462 return (a_date &gt; b_date) ? -1 : (a_date == b_date) ? 0 : 1;
2465 - static void describe(char *arg)
2466 -static void describe(struct commit *cmit, int last_one)
2467 ++static void describe(char *arg, int last_one)
2469 + unsigned char sha1[20];
2470 + struct commit *cmit;
2471 struct commit_list *list;
2472 static int initialized = 0;
2473 struct commit_name *n;
2475 + if (get_sha1(arg, sha1) &lt; 0)
2476 + usage(describe_usage);
2477 + cmit = lookup_commit_reference(sha1);
2478 + if (!cmit)
2479 + usage(describe_usage);
2481 if (!initialized) {
2482 initialized = 1;
2483 for_each_ref(get_name);</code></pre>
2484 </div></div>
2485 <div class="olist arabic"><ol class="arabic">
2486 <li>
2488 It is preceded by a "git diff" header, that looks like
2489 this (when the <code>-c</code> option is used):
2490 </p>
2491 <div class="literalblock">
2492 <div class="content">
2493 <pre><code>diff --combined file</code></pre>
2494 </div></div>
2495 <div class="paragraph"><p>or like this (when the <code>--cc</code> option is used):</p></div>
2496 <div class="literalblock">
2497 <div class="content">
2498 <pre><code>diff --cc file</code></pre>
2499 </div></div>
2500 </li>
2501 <li>
2503 It is followed by one or more extended header lines
2504 (this example shows a merge with two parents):
2505 </p>
2506 <div class="literalblock">
2507 <div class="content">
2508 <pre><code>index &lt;hash&gt;,&lt;hash&gt;..&lt;hash&gt;
2509 mode &lt;mode&gt;,&lt;mode&gt;..&lt;mode&gt;
2510 new file mode &lt;mode&gt;
2511 deleted file mode &lt;mode&gt;,&lt;mode&gt;</code></pre>
2512 </div></div>
2513 <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
2514 the &lt;mode&gt; is different from the rest. Extended headers with
2515 information about detected content movement (renames and
2516 copying detection) are designed to work with the diff of two
2517 &lt;tree-ish&gt; and are not used by combined diff format.</p></div>
2518 </li>
2519 <li>
2521 It is followed by a two-line from-file/to-file header:
2522 </p>
2523 <div class="literalblock">
2524 <div class="content">
2525 <pre><code>--- a/file
2526 +++ b/file</code></pre>
2527 </div></div>
2528 <div class="paragraph"><p>Similar to the two-line header for the traditional <em>unified</em> diff
2529 format, <code>/dev/null</code> is used to signal created or deleted
2530 files.</p></div>
2531 <div class="paragraph"><p>However, if the --combined-all-paths option is provided, instead of a
2532 two-line from-file/to-file, you get an N+1 line from-file/to-file header,
2533 where N is the number of parents in the merge commit:</p></div>
2534 <div class="literalblock">
2535 <div class="content">
2536 <pre><code>--- a/file
2537 --- a/file
2538 --- a/file
2539 +++ b/file</code></pre>
2540 </div></div>
2541 <div class="paragraph"><p>This extended format can be useful if rename or copy detection is
2542 active, to allow you to see the original name of the file in different
2543 parents.</p></div>
2544 </li>
2545 <li>
2547 Chunk header format is modified to prevent people from
2548 accidentally feeding it to <code>patch -p1</code>. Combined diff format
2549 was created for review of merge commit changes, and was not
2550 meant to be applied. The change is similar to the change in the
2551 extended <em>index</em> header:
2552 </p>
2553 <div class="literalblock">
2554 <div class="content">
2555 <pre><code>@@@ &lt;from-file-range&gt; &lt;from-file-range&gt; &lt;to-file-range&gt; @@@</code></pre>
2556 </div></div>
2557 <div class="paragraph"><p>There are (number of parents + 1) <code>@</code> characters in the chunk
2558 header for combined diff format.</p></div>
2559 </li>
2560 </ol></div>
2561 <div class="paragraph"><p>Unlike the traditional <em>unified</em> diff format, which shows two
2562 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
2563 added to B), or <code>" "</code> (space&#8201;&#8212;&#8201;unchanged) prefix, this format
2564 compares two or more files file1, file2,&#8230; with one file X, and
2565 shows how X differs from each of fileN. One column for each of
2566 fileN is prepended to the output line to note how X&#8217;s line is
2567 different from it.</p></div>
2568 <div class="paragraph"><p>A <code>-</code> character in the column N means that the line appears in
2569 fileN but it does not appear in the result. A <code>+</code> character
2570 in the column N means that the line appears in the result,
2571 and fileN does not have that line (in other words, the line was
2572 added, from the point of view of that parent).</p></div>
2573 <div class="paragraph"><p>In the above example output, the function signature was changed
2574 from both files (hence two <code>-</code> removals from both file1 and
2575 file2, plus <code>++</code> to mean one line that was added does not appear
2576 in either file1 or file2). Also, eight other lines are the same
2577 from file1 but do not appear in file2 (hence prefixed with <code>+</code>).</p></div>
2578 <div class="paragraph"><p>When shown by <code>git diff-tree -c</code>, it compares the parents of a
2579 merge commit with the merge result (i.e. file1..fileN are the
2580 parents). When shown by <code>git diff-files -c</code>, it compares the
2581 two unresolved merge parents with the working tree file
2582 (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka
2583 "their version").</p></div>
2584 </div>
2585 </div>
2586 <div class="sect1">
2587 <h2 id="_other_diff_formats">other diff formats</h2>
2588 <div class="sectionbody">
2589 <div class="paragraph"><p>The <code>--summary</code> option describes newly added, deleted, renamed and
2590 copied files. The <code>--stat</code> option adds diffstat(1) graph to the
2591 output. These options can be combined with other options, such as
2592 <code>-p</code>, and are meant for human consumption.</p></div>
2593 <div class="paragraph"><p>When showing a change that involves a rename or a copy, <code>--stat</code> output
2594 formats the pathnames compactly by combining common prefix and suffix of
2595 the pathnames. For example, a change that moves <code>arch/i386/Makefile</code> to
2596 <code>arch/x86/Makefile</code> while modifying 4 lines will be shown like this:</p></div>
2597 <div class="listingblock">
2598 <div class="content">
2599 <pre><code>arch/{i386 =&gt; x86}/Makefile | 4 +--</code></pre>
2600 </div></div>
2601 <div class="paragraph"><p>The <code>--numstat</code> option gives the diffstat(1) information but is designed
2602 for easier machine consumption. An entry in <code>--numstat</code> output looks
2603 like this:</p></div>
2604 <div class="listingblock">
2605 <div class="content">
2606 <pre><code>1 2 README
2607 3 1 arch/{i386 =&gt; x86}/Makefile</code></pre>
2608 </div></div>
2609 <div class="paragraph"><p>That is, from left to right:</p></div>
2610 <div class="olist arabic"><ol class="arabic">
2611 <li>
2613 the number of added lines;
2614 </p>
2615 </li>
2616 <li>
2618 a tab;
2619 </p>
2620 </li>
2621 <li>
2623 the number of deleted lines;
2624 </p>
2625 </li>
2626 <li>
2628 a tab;
2629 </p>
2630 </li>
2631 <li>
2633 pathname (possibly with rename/copy information);
2634 </p>
2635 </li>
2636 <li>
2638 a newline.
2639 </p>
2640 </li>
2641 </ol></div>
2642 <div class="paragraph"><p>When <code>-z</code> output option is in effect, the output is formatted this way:</p></div>
2643 <div class="listingblock">
2644 <div class="content">
2645 <pre><code>1 2 README NUL
2646 3 1 NUL arch/i386/Makefile NUL arch/x86/Makefile NUL</code></pre>
2647 </div></div>
2648 <div class="paragraph"><p>That is:</p></div>
2649 <div class="olist arabic"><ol class="arabic">
2650 <li>
2652 the number of added lines;
2653 </p>
2654 </li>
2655 <li>
2657 a tab;
2658 </p>
2659 </li>
2660 <li>
2662 the number of deleted lines;
2663 </p>
2664 </li>
2665 <li>
2667 a tab;
2668 </p>
2669 </li>
2670 <li>
2672 a NUL (only exists if renamed/copied);
2673 </p>
2674 </li>
2675 <li>
2677 pathname in preimage;
2678 </p>
2679 </li>
2680 <li>
2682 a NUL (only exists if renamed/copied);
2683 </p>
2684 </li>
2685 <li>
2687 pathname in postimage (only exists if renamed/copied);
2688 </p>
2689 </li>
2690 <li>
2692 a NUL.
2693 </p>
2694 </li>
2695 </ol></div>
2696 <div class="paragraph"><p>The extra <code>NUL</code> before the preimage path in renamed case is to allow
2697 scripts that read the output to tell if the current record being read is
2698 a single-path record or a rename/copy record without reading ahead.
2699 After reading added and deleted lines, reading up to <code>NUL</code> would yield
2700 the pathname, but if that is <code>NUL</code>, the record will show two paths.</p></div>
2701 </div>
2702 </div>
2703 <div class="sect1">
2704 <h2 id="_operating_modes">OPERATING MODES</h2>
2705 <div class="sectionbody">
2706 <div class="paragraph"><p>You can choose whether you want to trust the index file entirely
2707 (using the <code>--cached</code> flag) or ask the diff logic to show any files
2708 that don&#8217;t match the stat state as being "tentatively changed". Both
2709 of these operations are very useful indeed.</p></div>
2710 </div>
2711 </div>
2712 <div class="sect1">
2713 <h2 id="_cached_mode">CACHED MODE</h2>
2714 <div class="sectionbody">
2715 <div class="paragraph"><p>If <code>--cached</code> is specified, it allows you to ask:</p></div>
2716 <div class="literalblock">
2717 <div class="content">
2718 <pre><code>show me the differences between HEAD and the current index
2719 contents (the ones I'd write using 'git write-tree')</code></pre>
2720 </div></div>
2721 <div class="paragraph"><p>For example, let&#8217;s say that you have worked on your working directory, updated
2722 some files in the index and are ready to commit. You want to see exactly
2723 <strong>what</strong> you are going to commit, without having to write a new tree
2724 object and compare it that way, and to do that, you just do</p></div>
2725 <div class="literalblock">
2726 <div class="content">
2727 <pre><code>git diff-index --cached HEAD</code></pre>
2728 </div></div>
2729 <div class="paragraph"><p>Example: let&#8217;s say I had renamed <code>commit.c</code> to <code>git-commit.c</code>, and I had
2730 done an <code>update-index</code> to make that effective in the index file.
2731 <code>git diff-files</code> wouldn&#8217;t show anything at all, since the index file
2732 matches my working directory. But doing a <em>git diff-index</em> does:</p></div>
2733 <div class="literalblock">
2734 <div class="content">
2735 <pre><code>torvalds@ppc970:~/git&gt; git diff-index --cached HEAD
2736 :100644 000000 4161aecc6700a2eb579e842af0b7f22b98443f74 0000000000000000000000000000000000000000 D commit.c
2737 :000000 100644 0000000000000000000000000000000000000000 4161aecc6700a2eb579e842af0b7f22b98443f74 A git-commit.c</code></pre>
2738 </div></div>
2739 <div class="paragraph"><p>You can see easily that the above is a rename.</p></div>
2740 <div class="paragraph"><p>In fact, <code>git diff-index --cached</code> <strong>should</strong> always be entirely equivalent to
2741 actually doing a <em>git write-tree</em> and comparing that. Except this one is much
2742 nicer for the case where you just want to check where you are.</p></div>
2743 <div class="paragraph"><p>So doing a <code>git diff-index --cached</code> is basically very useful when you are
2744 asking yourself "what have I already marked for being committed, and
2745 what&#8217;s the difference to a previous tree".</p></div>
2746 </div>
2747 </div>
2748 <div class="sect1">
2749 <h2 id="_non_cached_mode">NON-CACHED MODE</h2>
2750 <div class="sectionbody">
2751 <div class="paragraph"><p>The "non-cached" mode takes a different approach, and is potentially
2752 the more useful of the two in that what it does can&#8217;t be emulated with
2753 a <em>git write-tree</em> + <em>git diff-tree</em>. Thus that&#8217;s the default mode.
2754 The non-cached version asks the question:</p></div>
2755 <div class="literalblock">
2756 <div class="content">
2757 <pre><code>show me the differences between HEAD and the currently checked out
2758 tree - index contents _and_ files that aren't up to date</code></pre>
2759 </div></div>
2760 <div class="paragraph"><p>which is obviously a very useful question too, since that tells you what
2761 you <strong>could</strong> commit. Again, the output matches the <em>git diff-tree -r</em>
2762 output to a tee, but with a twist.</p></div>
2763 <div class="paragraph"><p>The twist is that if some file doesn&#8217;t match the index, we don&#8217;t have
2764 a backing store thing for it, and we use the magic "all-zero" sha1 to
2765 show that. So let&#8217;s say that you have edited <code>kernel/sched.c</code>, but
2766 have not actually done a <em>git update-index</em> on it yet - there is no
2767 "object" associated with the new state, and you get:</p></div>
2768 <div class="literalblock">
2769 <div class="content">
2770 <pre><code>torvalds@ppc970:~/v2.6/linux&gt; git diff-index --abbrev HEAD
2771 :100644 100644 7476bb5ba 000000000 M kernel/sched.c</code></pre>
2772 </div></div>
2773 <div class="paragraph"><p>i.e., it shows that the tree has changed, and that <code>kernel/sched.c</code> is
2774 not up to date and may contain new stuff. The all-zero sha1 means that to
2775 get the real diff, you need to look at the object in the working directory
2776 directly rather than do an object-to-object diff.</p></div>
2777 <div class="admonitionblock">
2778 <table><tr>
2779 <td class="icon">
2780 <div class="title">Note</div>
2781 </td>
2782 <td class="content">As with other commands of this type, <em>git diff-index</em> does not
2783 actually look at the contents of the file at all. So maybe
2784 <code>kernel/sched.c</code> hasn&#8217;t actually changed, and it&#8217;s just that you
2785 touched it. In either case, it&#8217;s a note that you need to
2786 <em>git update-index</em> it to make the index be in sync.</td>
2787 </tr></table>
2788 </div>
2789 <div class="admonitionblock">
2790 <table><tr>
2791 <td class="icon">
2792 <div class="title">Note</div>
2793 </td>
2794 <td class="content">You can have a mixture of files show up as "has been updated"
2795 and "is still dirty in the working directory" together. You can always
2796 tell which file is in which state, since the "has been updated" ones
2797 show a valid sha1, and the "not in sync with the index" ones will
2798 always have the special all-zero sha1.</td>
2799 </tr></table>
2800 </div>
2801 </div>
2802 </div>
2803 <div class="sect1">
2804 <h2 id="_git">GIT</h2>
2805 <div class="sectionbody">
2806 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
2807 </div>
2808 </div>
2809 </div>
2810 <div id="footnotes"><hr /></div>
2811 <div id="footer">
2812 <div id="footer-text">
2813 Last updated
2814 2023-10-23 14:43:46 PDT
2815 </div>
2816 </div>
2817 </body>
2818 </html>