git-diff-tree.html

   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-tree(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  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;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  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;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 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;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 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;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 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;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 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;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 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; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 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;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 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;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 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; }
 392
 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; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 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;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 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.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 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);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 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);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 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);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 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);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 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;
 654   }
 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);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 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);
 682       }
 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;
 689     }
 690   }
 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>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-diff-tree(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-diff-tree -
 743    Compares the content and mode of blobs found via two tree 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 diff-tree</em> [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty]
 753               [-t] [-r] [-c | --cc] [--combined-all-paths] [--root] [--merge-base]
 754               [&lt;common-diff-options&gt;] &lt;tree-ish&gt; [&lt;tree-ish&gt;] [&lt;path&gt;&#8230;]</pre>
 755 <div class="attribution">
 756 </div></div>
 757 </div>
 758 </div>
 759 <div class="sect1">
 760 <h2 id="_description">DESCRIPTION</h2>
 761 <div class="sectionbody">
 762 <div class="paragraph"><p>Compare the content and mode of blobs found via two tree objects.</p></div>
 763 <div class="paragraph"><p>If there is only one &lt;tree-ish&gt; given, the commit is compared with its parents
 764 (see --stdin below).</p></div>
 765 <div class="paragraph"><p>Note that <em>git diff-tree</em> can use the tree encapsulated in a commit object.</p></div>
 766 </div>
 767 </div>
 768 <div class="sect1">
 769 <h2 id="_options">OPTIONS</h2>
 770 <div class="sectionbody">
 771 <div class="dlist"><dl>
 772 <dt class="hdlist1">
 773 -p
 774 </dt>
 775 <dt class="hdlist1">
 776 -u
 777 </dt>
 778 <dt class="hdlist1">
 779 --patch
 780 </dt>
 781 <dd>
 782 <p>
 783         Generate patch (see <a href="#generate_patch_text_with_p">[generate_patch_text_with_p]</a>).
 784 </p>
 785 </dd>
 786 <dt class="hdlist1">
 787 -s
 788 </dt>
 789 <dt class="hdlist1">
 790 --no-patch
 791 </dt>
 792 <dd>
 793 <p>
 794         Suppress all output from the diff machinery.  Useful for
 795         commands like <code>git show</code> that show the patch by default to
 796         squelch their output, or to cancel the effect of options like
 797         <code>--patch</code>, <code>--stat</code> earlier on the command line in an alias.
 798 </p>
 799 </dd>
 800 <dt class="hdlist1">
 801 -U&lt;n&gt;
 802 </dt>
 803 <dt class="hdlist1">
 804 --unified=&lt;n&gt;
 805 </dt>
 806 <dd>
 807 <p>
 808         Generate diffs with &lt;n&gt; lines of context instead of
 809         the usual three.
 810         Implies <code>--patch</code>.
 811 </p>
 812 </dd>
 813 <dt class="hdlist1">
 814 --output=&lt;file&gt;
 815 </dt>
 816 <dd>
 817 <p>
 818         Output to a specific file instead of stdout.
 819 </p>
 820 </dd>
 821 <dt class="hdlist1">
 822 --output-indicator-new=&lt;char&gt;
 823 </dt>
 824 <dt class="hdlist1">
 825 --output-indicator-old=&lt;char&gt;
 826 </dt>
 827 <dt class="hdlist1">
 828 --output-indicator-context=&lt;char&gt;
 829 </dt>
 830 <dd>
 831 <p>
 832         Specify the character used to indicate new, old or context
 833         lines in the generated patch. Normally they are <em>+</em>, <em>-</em> and
 834         ' ' respectively.
 835 </p>
 836 </dd>
 837 <dt class="hdlist1">
 838 --raw
 839 </dt>
 840 <dd>
 841 <p>
 842         Generate the diff in raw format.
 843         This is the default.
 844 </p>
 845 </dd>
 846 <dt class="hdlist1">
 847 --patch-with-raw
 848 </dt>
 849 <dd>
 850 <p>
 851         Synonym for <code>-p --raw</code>.
 852 </p>
 853 </dd>
 854 <dt class="hdlist1">
 855 --indent-heuristic
 856 </dt>
 857 <dd>
 858 <p>
 859         Enable the heuristic that shifts diff hunk boundaries to make patches
 860         easier to read. This is the default.
 861 </p>
 862 </dd>
 863 <dt class="hdlist1">
 864 --no-indent-heuristic
 865 </dt>
 866 <dd>
 867 <p>
 868         Disable the indent heuristic.
 869 </p>
 870 </dd>
 871 <dt class="hdlist1">
 872 --minimal
 873 </dt>
 874 <dd>
 875 <p>
 876         Spend extra time to make sure the smallest possible
 877         diff is produced.
 878 </p>
 879 </dd>
 880 <dt class="hdlist1">
 881 --patience
 882 </dt>
 883 <dd>
 884 <p>
 885         Generate a diff using the "patience diff" algorithm.
 886 </p>
 887 </dd>
 888 <dt class="hdlist1">
 889 --histogram
 890 </dt>
 891 <dd>
 892 <p>
 893         Generate a diff using the "histogram diff" algorithm.
 894 </p>
 895 </dd>
 896 <dt class="hdlist1">
 897 --anchored=&lt;text&gt;
 898 </dt>
 899 <dd>
 900 <p>
 901         Generate a diff using the "anchored diff" algorithm.
 902 </p>
 903 <div class="paragraph"><p>This option may be specified more than once.</p></div>
 904 <div class="paragraph"><p>If a line exists in both the source and destination, exists only once,
 905 and starts with this text, this algorithm attempts to prevent it from
 906 appearing as a deletion or addition in the output. It uses the "patience
 907 diff" algorithm internally.</p></div>
 908 </dd>
 909 <dt class="hdlist1">
 910 --diff-algorithm={patience|minimal|histogram|myers}
 911 </dt>
 912 <dd>
 913 <p>
 914         Choose a diff algorithm. The variants are as follows:
 915 </p>
 916 <div class="openblock">
 917 <div class="content">
 918 <div class="dlist"><dl>
 919 <dt class="hdlist1">
 920 <code>default</code>, <code>myers</code>
 921 </dt>
 922 <dd>
 923 <p>
 924         The basic greedy diff algorithm. Currently, this is the default.
 925 </p>
 926 </dd>
 927 <dt class="hdlist1">
 928 <code>minimal</code>
 929 </dt>
 930 <dd>
 931 <p>
 932         Spend extra time to make sure the smallest possible diff is
 933         produced.
 934 </p>
 935 </dd>
 936 <dt class="hdlist1">
 937 <code>patience</code>
 938 </dt>
 939 <dd>
 940 <p>
 941         Use "patience diff" algorithm when generating patches.
 942 </p>
 943 </dd>
 944 <dt class="hdlist1">
 945 <code>histogram</code>
 946 </dt>
 947 <dd>
 948 <p>
 949         This algorithm extends the patience algorithm to "support
 950         low-occurrence common elements".
 951 </p>
 952 </dd>
 953 </dl></div>
 954 </div></div>
 955 <div class="paragraph"><p>For instance, if you configured the <code>diff.algorithm</code> variable to a
 956 non-default value and want to use the default one, then you
 957 have to use <code>--diff-algorithm=default</code> option.</p></div>
 958 </dd>
 959 <dt class="hdlist1">
 960 --stat[=&lt;width&gt;[,&lt;name-width&gt;[,&lt;count&gt;]]]
 961 </dt>
 962 <dd>
 963 <p>
 964         Generate a diffstat. By default, as much space as necessary
 965         will be used for the filename part, and the rest for the graph
 966         part. Maximum width defaults to terminal width, or 80 columns
 967         if not connected to a terminal, and can be overridden by
 968         <code>&lt;width&gt;</code>. The width of the filename part can be limited by
 969         giving another width <code>&lt;name-width&gt;</code> after a comma or by setting
 970         <code>diff.statNameWidth=&lt;width&gt;</code>. The width of the graph part can be
 971         limited by using <code>--stat-graph-width=&lt;width&gt;</code> or by setting
 972         <code>diff.statGraphWidth=&lt;width&gt;</code>. Using <code>--stat</code> or
 973         <code>--stat-graph-width</code> affects all commands generating a stat graph,
 974         while setting <code>diff.statNameWidth</code> or <code>diff.statGraphWidth</code>
 975         does not affect <code>git format-patch</code>.
 976         By giving a third parameter <code>&lt;count&gt;</code>, you can limit the output to
 977         the first <code>&lt;count&gt;</code> lines, followed by <code>...</code> if there are more.
 978 </p>
 979 <div class="paragraph"><p>These parameters can also be set individually with <code>--stat-width=&lt;width&gt;</code>,
 980 <code>--stat-name-width=&lt;name-width&gt;</code> and <code>--stat-count=&lt;count&gt;</code>.</p></div>
 981 </dd>
 982 <dt class="hdlist1">
 983 --compact-summary
 984 </dt>
 985 <dd>
 986 <p>
 987         Output a condensed summary of extended header information such
 988         as file creations or deletions ("new" or "gone", optionally "+l"
 989         if it&#8217;s a symlink) and mode changes ("+x" or "-x" for adding
 990         or removing executable bit respectively) in diffstat. The
 991         information is put between the filename part and the graph
 992         part. Implies <code>--stat</code>.
 993 </p>
 994 </dd>
 995 <dt class="hdlist1">
 996 --numstat
 997 </dt>
 998 <dd>
 999 <p>
1000         Similar to <code>--stat</code>, but shows number of added and
1001         deleted lines in decimal notation and pathname without
1002         abbreviation, to make it more machine friendly.  For
1003         binary files, outputs two <code>-</code> instead of saying
1004         <code>0 0</code>.
1005 </p>
1006 </dd>
1007 <dt class="hdlist1">
1008 --shortstat
1009 </dt>
1010 <dd>
1011 <p>
1012         Output only the last line of the <code>--stat</code> format containing total
1013         number of modified files, as well as number of added and deleted
1014         lines.
1015 </p>
1016 </dd>
1017 <dt class="hdlist1">
1018 -X[&lt;param1,param2,&#8230;&gt;]
1019 </dt>
1020 <dt class="hdlist1">
1021 --dirstat[=&lt;param1,param2,&#8230;&gt;]
1022 </dt>
1023 <dd>
1024 <p>
1025         Output the distribution of relative amount of changes for each
1026         sub-directory. The behavior of <code>--dirstat</code> can be customized by
1027         passing it a comma separated list of parameters.
1028         The defaults are controlled by the <code>diff.dirstat</code> configuration
1029         variable (see <a href="git-config.html">git-config(1)</a>).
1030         The following parameters are available:
1031 </p>
1032 <div class="openblock">
1033 <div class="content">
1034 <div class="dlist"><dl>
1035 <dt class="hdlist1">
1036 <code>changes</code>
1037 </dt>
1038 <dd>
1039 <p>
1040         Compute the dirstat numbers by counting the lines that have been
1041         removed from the source, or added to the destination. This ignores
1042         the amount of pure code movements within a file.  In other words,
1043         rearranging lines in a file is not counted as much as other changes.
1044         This is the default behavior when no parameter is given.
1045 </p>
1046 </dd>
1047 <dt class="hdlist1">
1048 <code>lines</code>
1049 </dt>
1050 <dd>
1051 <p>
1052         Compute the dirstat numbers by doing the regular line-based diff
1053         analysis, and summing the removed/added line counts. (For binary
1054         files, count 64-byte chunks instead, since binary files have no
1055         natural concept of lines). This is a more expensive <code>--dirstat</code>
1056         behavior than the <code>changes</code> behavior, but it does count rearranged
1057         lines within a file as much as other changes. The resulting output
1058         is consistent with what you get from the other <code>--*stat</code> options.
1059 </p>
1060 </dd>
1061 <dt class="hdlist1">
1062 <code>files</code>
1063 </dt>
1064 <dd>
1065 <p>
1066         Compute the dirstat numbers by counting the number of files changed.
1067         Each changed file counts equally in the dirstat analysis. This is
1068         the computationally cheapest <code>--dirstat</code> behavior, since it does
1069         not have to look at the file contents at all.
1070 </p>
1071 </dd>
1072 <dt class="hdlist1">
1073 <code>cumulative</code>
1074 </dt>
1075 <dd>
1076 <p>
1077         Count changes in a child directory for the parent directory as well.
1078         Note that when using <code>cumulative</code>, the sum of the percentages
1079         reported may exceed 100%. The default (non-cumulative) behavior can
1080         be specified with the <code>noncumulative</code> parameter.
1081 </p>
1082 </dd>
1083 <dt class="hdlist1">
1084 &lt;limit&gt;
1085 </dt>
1086 <dd>
1087 <p>
1088         An integer parameter specifies a cut-off percent (3% by default).
1089         Directories contributing less than this percentage of the changes
1090         are not shown in the output.
1091 </p>
1092 </dd>
1093 </dl></div>
1094 </div></div>
1095 <div class="paragraph"><p>Example: The following will count changed files, while ignoring
1096 directories with less than 10% of the total amount of changed files,
1097 and accumulating child directory counts in the parent directories:
1098 <code>--dirstat=files,10,cumulative</code>.</p></div>
1099 </dd>
1100 <dt class="hdlist1">
1101 --cumulative
1102 </dt>
1103 <dd>
1104 <p>
1105         Synonym for --dirstat=cumulative
1106 </p>
1107 </dd>
1108 <dt class="hdlist1">
1109 --dirstat-by-file[=&lt;param1,param2&gt;&#8230;]
1110 </dt>
1111 <dd>
1112 <p>
1113         Synonym for --dirstat=files,param1,param2&#8230;
1114 </p>
1115 </dd>
1116 <dt class="hdlist1">
1117 --summary
1118 </dt>
1119 <dd>
1120 <p>
1121         Output a condensed summary of extended header information
1122         such as creations, renames and mode changes.
1123 </p>
1124 </dd>
1125 <dt class="hdlist1">
1126 --patch-with-stat
1127 </dt>
1128 <dd>
1129 <p>
1130         Synonym for <code>-p --stat</code>.
1131 </p>
1132 </dd>
1133 <dt class="hdlist1">
1134 -z
1135 </dt>
1136 <dd>
1137 <p>
1138         When <code>--raw</code>, <code>--numstat</code>, <code>--name-only</code> or <code>--name-status</code> has been
1139         given, do not munge pathnames and use NULs as output field terminators.
1140 </p>
1141 <div class="paragraph"><p>Without this option, pathnames with "unusual" characters are quoted as
1142 explained for the configuration variable <code>core.quotePath</code> (see
1143 <a href="git-config.html">git-config(1)</a>).</p></div>
1144 </dd>
1145 <dt class="hdlist1">
1146 --name-only
1147 </dt>
1148 <dd>
1149 <p>
1150         Show only names of changed files. The file names are often encoded in UTF-8.
1151         For more information see the discussion about encoding in the <a href="git-log.html">git-log(1)</a>
1152         manual page.
1153 </p>
1154 </dd>
1155 <dt class="hdlist1">
1156 --name-status
1157 </dt>
1158 <dd>
1159 <p>
1160         Show only names and status of changed files. See the description
1161         of the <code>--diff-filter</code> option on what the status letters mean.
1162         Just like <code>--name-only</code> the file names are often encoded in UTF-8.
1163 </p>
1164 </dd>
1165 <dt class="hdlist1">
1166 --submodule[=&lt;format&gt;]
1167 </dt>
1168 <dd>
1169 <p>
1170         Specify how differences in submodules are shown.  When specifying
1171         <code>--submodule=short</code> the <em>short</em> format is used.  This format just
1172         shows the names of the commits at the beginning and end of the range.
1173         When <code>--submodule</code> or <code>--submodule=log</code> is specified, the <em>log</em>
1174         format is used.  This format lists the commits in the range like
1175         <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code> does.  When <code>--submodule=diff</code>
1176         is specified, the <em>diff</em> format is used.  This format shows an
1177         inline diff of the changes in the submodule contents between the
1178         commit range.  Defaults to <code>diff.submodule</code> or the <em>short</em> format
1179         if the config option is unset.
1180 </p>
1181 </dd>
1182 <dt class="hdlist1">
1183 --color[=&lt;when&gt;]
1184 </dt>
1185 <dd>
1186 <p>
1187         Show colored diff.
1188         <code>--color</code> (i.e. without <em>=&lt;when&gt;</em>) is the same as <code>--color=always</code>.
1189         <em>&lt;when&gt;</em> can be one of <code>always</code>, <code>never</code>, or <code>auto</code>.
1190 </p>
1191 </dd>
1192 <dt class="hdlist1">
1193 --no-color
1194 </dt>
1195 <dd>
1196 <p>
1197         Turn off colored diff.
1198         It is the same as <code>--color=never</code>.
1199 </p>
1200 </dd>
1201 <dt class="hdlist1">
1202 --color-moved[=&lt;mode&gt;]
1203 </dt>
1204 <dd>
1205 <p>
1206         Moved lines of code are colored differently.
1207         The &lt;mode&gt; defaults to <em>no</em> if the option is not given
1208         and to <em>zebra</em> if the option with no mode is given.
1209         The mode must be one of:
1210 </p>
1211 <div class="openblock">
1212 <div class="content">
1213 <div class="dlist"><dl>
1214 <dt class="hdlist1">
1215 no
1216 </dt>
1217 <dd>
1218 <p>
1219         Moved lines are not highlighted.
1220 </p>
1221 </dd>
1222 <dt class="hdlist1">
1223 default
1224 </dt>
1225 <dd>
1226 <p>
1227         Is a synonym for <code>zebra</code>. This may change to a more sensible mode
1228         in the future.
1229 </p>
1230 </dd>
1231 <dt class="hdlist1">
1232 plain
1233 </dt>
1234 <dd>
1235 <p>
1236         Any line that is added in one location and was removed
1237         in another location will be colored with <em>color.diff.newMoved</em>.
1238         Similarly <em>color.diff.oldMoved</em> will be used for removed lines
1239         that are added somewhere else in the diff. This mode picks up any
1240         moved line, but it is not very useful in a review to determine
1241         if a block of code was moved without permutation.
1242 </p>
1243 </dd>
1244 <dt class="hdlist1">
1245 blocks
1246 </dt>
1247 <dd>
1248 <p>
1249         Blocks of moved text of at least 20 alphanumeric characters
1250         are detected greedily. The detected blocks are
1251         painted using either the <em>color.diff.{old,new}Moved</em> color.
1252         Adjacent blocks cannot be told apart.
1253 </p>
1254 </dd>
1255 <dt class="hdlist1">
1256 zebra
1257 </dt>
1258 <dd>
1259 <p>
1260         Blocks of moved text are detected as in <em>blocks</em> mode. The blocks
1261         are painted using either the <em>color.diff.{old,new}Moved</em> color or
1262         <em>color.diff.{old,new}MovedAlternative</em>. The change between
1263         the two colors indicates that a new block was detected.
1264 </p>
1265 </dd>
1266 <dt class="hdlist1">
1267 dimmed-zebra
1268 </dt>
1269 <dd>
1270 <p>
1271         Similar to <em>zebra</em>, but additional dimming of uninteresting parts
1272         of moved code is performed. The bordering lines of two adjacent
1273         blocks are considered interesting, the rest is uninteresting.
1274         <code>dimmed_zebra</code> is a deprecated synonym.
1275 </p>
1276 </dd>
1277 </dl></div>
1278 </div></div>
1279 </dd>
1280 <dt class="hdlist1">
1281 --no-color-moved
1282 </dt>
1283 <dd>
1284 <p>
1285         Turn off move detection. This can be used to override configuration
1286         settings. It is the same as <code>--color-moved=no</code>.
1287 </p>
1288 </dd>
1289 <dt class="hdlist1">
1290 --color-moved-ws=&lt;modes&gt;
1291 </dt>
1292 <dd>
1293 <p>
1294         This configures how whitespace is ignored when performing the
1295         move detection for <code>--color-moved</code>.
1296         These modes can be given as a comma separated list:
1297 </p>
1298 <div class="openblock">
1299 <div class="content">
1300 <div class="dlist"><dl>
1301 <dt class="hdlist1">
1302 no
1303 </dt>
1304 <dd>
1305 <p>
1306         Do not ignore whitespace when performing move detection.
1307 </p>
1308 </dd>
1309 <dt class="hdlist1">
1310 ignore-space-at-eol
1311 </dt>
1312 <dd>
1313 <p>
1314         Ignore changes in whitespace at EOL.
1315 </p>
1316 </dd>
1317 <dt class="hdlist1">
1318 ignore-space-change
1319 </dt>
1320 <dd>
1321 <p>
1322         Ignore changes in amount of whitespace.  This ignores whitespace
1323         at line end, and considers all other sequences of one or
1324         more whitespace characters to be equivalent.
1325 </p>
1326 </dd>
1327 <dt class="hdlist1">
1328 ignore-all-space
1329 </dt>
1330 <dd>
1331 <p>
1332         Ignore whitespace when comparing lines. This ignores differences
1333         even if one line has whitespace where the other line has none.
1334 </p>
1335 </dd>
1336 <dt class="hdlist1">
1337 allow-indentation-change
1338 </dt>
1339 <dd>
1340 <p>
1341         Initially ignore any whitespace in the move detection, then
1342         group the moved code blocks only into a block if the change in
1343         whitespace is the same per line. This is incompatible with the
1344         other modes.
1345 </p>
1346 </dd>
1347 </dl></div>
1348 </div></div>
1349 </dd>
1350 <dt class="hdlist1">
1351 --no-color-moved-ws
1352 </dt>
1353 <dd>
1354 <p>
1355         Do not ignore whitespace when performing move detection. This can be
1356         used to override configuration settings. It is the same as
1357         <code>--color-moved-ws=no</code>.
1358 </p>
1359 </dd>
1360 <dt class="hdlist1">
1361 --word-diff[=&lt;mode&gt;]
1362 </dt>
1363 <dd>
1364 <p>
1365         Show a word diff, using the &lt;mode&gt; to delimit changed words.
1366         By default, words are delimited by whitespace; see
1367         <code>--word-diff-regex</code> below.  The &lt;mode&gt; defaults to <em>plain</em>, and
1368         must be one of:
1369 </p>
1370 <div class="openblock">
1371 <div class="content">
1372 <div class="dlist"><dl>
1373 <dt class="hdlist1">
1374 color
1375 </dt>
1376 <dd>
1377 <p>
1378         Highlight changed words using only colors.  Implies <code>--color</code>.
1379 </p>
1380 </dd>
1381 <dt class="hdlist1">
1382 plain
1383 </dt>
1384 <dd>
1385 <p>
1386         Show words as <code>[-removed-]</code> and <code>{+added+}</code>.  Makes no
1387         attempts to escape the delimiters if they appear in the input,
1388         so the output may be ambiguous.
1389 </p>
1390 </dd>
1391 <dt class="hdlist1">
1392 porcelain
1393 </dt>
1394 <dd>
1395 <p>
1396         Use a special line-based format intended for script
1397         consumption.  Added/removed/unchanged runs are printed in the
1398         usual unified diff format, starting with a <code>+</code>/<code>-</code>/` `
1399         character at the beginning of the line and extending to the
1400         end of the line.  Newlines in the input are represented by a
1401         tilde <code>~</code> on a line of its own.
1402 </p>
1403 </dd>
1404 <dt class="hdlist1">
1405 none
1406 </dt>
1407 <dd>
1408 <p>
1409         Disable word diff again.
1410 </p>
1411 </dd>
1412 </dl></div>
1413 </div></div>
1414 <div class="paragraph"><p>Note that despite the name of the first mode, color is used to
1415 highlight the changed parts in all modes if enabled.</p></div>
1416 </dd>
1417 <dt class="hdlist1">
1418 --word-diff-regex=&lt;regex&gt;
1419 </dt>
1420 <dd>
1421 <p>
1422         Use &lt;regex&gt; to decide what a word is, instead of considering
1423         runs of non-whitespace to be a word.  Also implies
1424         <code>--word-diff</code> unless it was already enabled.
1425 </p>
1426 <div class="paragraph"><p>Every non-overlapping match of the
1427 &lt;regex&gt; is considered a word.  Anything between these matches is
1428 considered whitespace and ignored(!) for the purposes of finding
1429 differences.  You may want to append <code>|[^[:space:]]</code> to your regular
1430 expression to make sure that it matches all non-whitespace characters.
1431 A match that contains a newline is silently truncated(!) at the
1432 newline.</p></div>
1433 <div class="paragraph"><p>For example, <code>--word-diff-regex=.</code> will treat each character as a word
1434 and, correspondingly, show differences character by character.</p></div>
1435 <div class="paragraph"><p>The regex can also be set via a diff driver or configuration option, see
1436 <a href="gitattributes.html">gitattributes(5)</a> or <a href="git-config.html">git-config(1)</a>.  Giving it explicitly
1437 overrides any diff driver or configuration setting.  Diff drivers
1438 override configuration settings.</p></div>
1439 </dd>
1440 <dt class="hdlist1">
1441 --color-words[=&lt;regex&gt;]
1442 </dt>
1443 <dd>
1444 <p>
1445         Equivalent to <code>--word-diff=color</code> plus (if a regex was
1446         specified) <code>--word-diff-regex=&lt;regex&gt;</code>.
1447 </p>
1448 </dd>
1449 <dt class="hdlist1">
1450 --no-renames
1451 </dt>
1452 <dd>
1453 <p>
1454         Turn off rename detection, even when the configuration
1455         file gives the default to do so.
1456 </p>
1457 </dd>
1458 <dt class="hdlist1">
1459 --[no-]rename-empty
1460 </dt>
1461 <dd>
1462 <p>
1463         Whether to use empty blobs as rename source.
1464 </p>
1465 </dd>
1466 <dt class="hdlist1">
1467 --check
1468 </dt>
1469 <dd>
1470 <p>
1471         Warn if changes introduce conflict markers or whitespace errors.
1472         What are considered whitespace errors is controlled by <code>core.whitespace</code>
1473         configuration.  By default, trailing whitespaces (including
1474         lines that consist solely of whitespaces) and a space character
1475         that is immediately followed by a tab character inside the
1476         initial indent of the line are considered whitespace errors.
1477         Exits with non-zero status if problems are found. Not compatible
1478         with --exit-code.
1479 </p>
1480 </dd>
1481 <dt class="hdlist1">
1482 --ws-error-highlight=&lt;kind&gt;
1483 </dt>
1484 <dd>
1485 <p>
1486         Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
1487         lines of the diff.  Multiple values are separated by comma,
1488         <code>none</code> resets previous values, <code>default</code> reset the list to
1489         <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>.  When
1490         this option is not given, and the configuration variable
1491         <code>diff.wsErrorHighlight</code> is not set, only whitespace errors in
1492         <code>new</code> lines are highlighted. The whitespace errors are colored
1493         with <code>color.diff.whitespace</code>.
1494 </p>
1495 </dd>
1496 <dt class="hdlist1">
1497 --full-index
1498 </dt>
1499 <dd>
1500 <p>
1501         Instead of the first handful of characters, show the full
1502         pre- and post-image blob object names on the "index"
1503         line when generating patch format output.
1504 </p>
1505 </dd>
1506 <dt class="hdlist1">
1507 --binary
1508 </dt>
1509 <dd>
1510 <p>
1511         In addition to <code>--full-index</code>, output a binary diff that
1512         can be applied with <code>git-apply</code>.
1513         Implies <code>--patch</code>.
1514 </p>
1515 </dd>
1516 <dt class="hdlist1">
1517 --abbrev[=&lt;n&gt;]
1518 </dt>
1519 <dd>
1520 <p>
1521         Instead of showing the full 40-byte hexadecimal object
1522         name in diff-raw format output and diff-tree header
1523         lines, show the shortest prefix that is at least <em>&lt;n&gt;</em>
1524         hexdigits long that uniquely refers the object.
1525         In diff-patch output format, <code>--full-index</code> takes higher
1526         precedence, i.e. if <code>--full-index</code> is specified, full blob
1527         names will be shown regardless of <code>--abbrev</code>.
1528         Non default number of digits can be specified with <code>--abbrev=&lt;n&gt;</code>.
1529 </p>
1530 </dd>
1531 <dt class="hdlist1">
1532 -B[&lt;n&gt;][/&lt;m&gt;]
1533 </dt>
1534 <dt class="hdlist1">
1535 --break-rewrites[=[&lt;n&gt;][/&lt;m&gt;]]
1536 </dt>
1537 <dd>
1538 <p>
1539         Break complete rewrite changes into pairs of delete and
1540         create. This serves two purposes:
1541 </p>
1542 <div class="paragraph"><p>It affects the way a change that amounts to a total rewrite of a file
1543 not as a series of deletion and insertion mixed together with a very
1544 few lines that happen to match textually as the context, but as a
1545 single deletion of everything old followed by a single insertion of
1546 everything new, and the number <code>m</code> controls this aspect of the -B
1547 option (defaults to 60%). <code>-B/70%</code> specifies that less than 30% of the
1548 original should remain in the result for Git to consider it a total
1549 rewrite (i.e. otherwise the resulting patch will be a series of
1550 deletion and insertion mixed together with context lines).</p></div>
1551 <div class="paragraph"><p>When used with -M, a totally-rewritten file is also considered as the
1552 source of a rename (usually -M only considers a file that disappeared
1553 as the source of a rename), and the number <code>n</code> controls this aspect of
1554 the -B option (defaults to 50%). <code>-B20%</code> specifies that a change with
1555 addition and deletion compared to 20% or more of the file&#8217;s size are
1556 eligible for being picked up as a possible source of a rename to
1557 another file.</p></div>
1558 </dd>
1559 <dt class="hdlist1">
1560 -M[&lt;n&gt;]
1561 </dt>
1562 <dt class="hdlist1">
1563 --find-renames[=&lt;n&gt;]
1564 </dt>
1565 <dd>
1566 <p>
1567         Detect renames.
1568         If <code>n</code> is specified, it is a threshold on the similarity
1569         index (i.e. amount of addition/deletions compared to the
1570         file&#8217;s size). For example, <code>-M90%</code> means Git should consider a
1571         delete/add pair to be a rename if more than 90% of the file
1572         hasn&#8217;t changed.  Without a <code>%</code> sign, the number is to be read as
1573         a fraction, with a decimal point before it.  I.e., <code>-M5</code> becomes
1574         0.5, and is thus the same as <code>-M50%</code>.  Similarly, <code>-M05</code> is
1575         the same as <code>-M5%</code>.  To limit detection to exact renames, use
1576         <code>-M100%</code>.  The default similarity index is 50%.
1577 </p>
1578 </dd>
1579 <dt class="hdlist1">
1580 -C[&lt;n&gt;]
1581 </dt>
1582 <dt class="hdlist1">
1583 --find-copies[=&lt;n&gt;]
1584 </dt>
1585 <dd>
1586 <p>
1587         Detect copies as well as renames.  See also <code>--find-copies-harder</code>.
1588         If <code>n</code> is specified, it has the same meaning as for <code>-M&lt;n&gt;</code>.
1589 </p>
1590 </dd>
1591 <dt class="hdlist1">
1592 --find-copies-harder
1593 </dt>
1594 <dd>
1595 <p>
1596         For performance reasons, by default, <code>-C</code> option finds copies only
1597         if the original file of the copy was modified in the same
1598         changeset.  This flag makes the command
1599         inspect unmodified files as candidates for the source of
1600         copy.  This is a very expensive operation for large
1601         projects, so use it with caution.  Giving more than one
1602         <code>-C</code> option has the same effect.
1603 </p>
1604 </dd>
1605 <dt class="hdlist1">
1606 -D
1607 </dt>
1608 <dt class="hdlist1">
1609 --irreversible-delete
1610 </dt>
1611 <dd>
1612 <p>
1613         Omit the preimage for deletes, i.e. print only the header but not
1614         the diff between the preimage and <code>/dev/null</code>. The resulting patch
1615         is not meant to be applied with <code>patch</code> or <code>git apply</code>; this is
1616         solely for people who want to just concentrate on reviewing the
1617         text after the change. In addition, the output obviously lacks
1618         enough information to apply such a patch in reverse, even manually,
1619         hence the name of the option.
1620 </p>
1621 <div class="paragraph"><p>When used together with <code>-B</code>, omit also the preimage in the deletion part
1622 of a delete/create pair.</p></div>
1623 </dd>
1624 <dt class="hdlist1">
1625 -l&lt;num&gt;
1626 </dt>
1627 <dd>
1628 <p>
1629         The <code>-M</code> and <code>-C</code> options involve some preliminary steps that
1630         can detect subsets of renames/copies cheaply, followed by an
1631         exhaustive fallback portion that compares all remaining
1632         unpaired destinations to all relevant sources.  (For renames,
1633         only remaining unpaired sources are relevant; for copies, all
1634         original sources are relevant.)  For N sources and
1635         destinations, this exhaustive check is O(N^2).  This option
1636         prevents the exhaustive portion of rename/copy detection from
1637         running if the number of source/destination files involved
1638         exceeds the specified number.  Defaults to diff.renameLimit.
1639         Note that a value of 0 is treated as unlimited.
1640 </p>
1641 </dd>
1642 <dt class="hdlist1">
1643 --diff-filter=[(A|C|D|M|R|T|U|X|B)&#8230;[*]]
1644 </dt>
1645 <dd>
1646 <p>
1647         Select only files that are Added (<code>A</code>), Copied (<code>C</code>),
1648         Deleted (<code>D</code>), Modified (<code>M</code>), Renamed (<code>R</code>), have their
1649         type (i.e. regular file, symlink, submodule, &#8230;) changed (<code>T</code>),
1650         are Unmerged (<code>U</code>), are
1651         Unknown (<code>X</code>), or have had their pairing Broken (<code>B</code>).
1652         Any combination of the filter characters (including none) can be used.
1653         When <code>*</code> (All-or-none) is added to the combination, all
1654         paths are selected if there is any file that matches
1655         other criteria in the comparison; if there is no file
1656         that matches other criteria, nothing is selected.
1657 </p>
1658 <div class="paragraph"><p>Also, these upper-case letters can be downcased to exclude.  E.g.
1659 <code>--diff-filter=ad</code> excludes added and deleted paths.</p></div>
1660 <div class="paragraph"><p>Note that not all diffs can feature all types. For instance, copied and
1661 renamed entries cannot appear if detection for those types is disabled.</p></div>
1662 </dd>
1663 <dt class="hdlist1">
1664 -S&lt;string&gt;
1665 </dt>
1666 <dd>
1667 <p>
1668         Look for differences that change the number of occurrences of
1669         the specified string (i.e. addition/deletion) in a file.
1670         Intended for the scripter&#8217;s use.
1671 </p>
1672 <div class="paragraph"><p>It is useful when you&#8217;re looking for an exact block of code (like a
1673 struct), and want to know the history of that block since it first
1674 came into being: use the feature iteratively to feed the interesting
1675 block in the preimage back into <code>-S</code>, and keep going until you get the
1676 very first version of the block.</p></div>
1677 <div class="paragraph"><p>Binary files are searched as well.</p></div>
1678 </dd>
1679 <dt class="hdlist1">
1680 -G&lt;regex&gt;
1681 </dt>
1682 <dd>
1683 <p>
1684         Look for differences whose patch text contains added/removed
1685         lines that match &lt;regex&gt;.
1686 </p>
1687 <div class="paragraph"><p>To illustrate the difference between <code>-S&lt;regex&gt; --pickaxe-regex</code> and
1688 <code>-G&lt;regex&gt;</code>, consider a commit with the following diff in the same
1689 file:</p></div>
1690 <div class="listingblock">
1691 <div class="content">
1692 <pre><code>+    return frotz(nitfol, two-&gt;ptr, 1, 0);
1693 ...
1694 -    hit = frotz(nitfol, mf2.ptr, 1, 0);</code></pre>
1695 </div></div>
1696 <div class="paragraph"><p>While <code>git log -G"frotz\(nitfol"</code> will show this commit, <code>git log
1697 -S"frotz\(nitfol" --pickaxe-regex</code> will not (because the number of
1698 occurrences of that string did not change).</p></div>
1699 <div class="paragraph"><p>Unless <code>--text</code> is supplied patches of binary files without a textconv
1700 filter will be ignored.</p></div>
1701 <div class="paragraph"><p>See the <em>pickaxe</em> entry in <a href="gitdiffcore.html">gitdiffcore(7)</a> for more
1702 information.</p></div>
1703 </dd>
1704 <dt class="hdlist1">
1705 --find-object=&lt;object-id&gt;
1706 </dt>
1707 <dd>
1708 <p>
1709         Look for differences that change the number of occurrences of
1710         the specified object. Similar to <code>-S</code>, just the argument is different
1711         in that it doesn&#8217;t search for a specific string but for a specific
1712         object id.
1713 </p>
1714 <div class="paragraph"><p>The object can be a blob or a submodule commit. It implies the <code>-t</code> option in
1715 <code>git-log</code> to also find trees.</p></div>
1716 </dd>
1717 <dt class="hdlist1">
1718 --pickaxe-all
1719 </dt>
1720 <dd>
1721 <p>
1722         When <code>-S</code> or <code>-G</code> finds a change, show all the changes in that
1723         changeset, not just the files that contain the change
1724         in &lt;string&gt;.
1725 </p>
1726 </dd>
1727 <dt class="hdlist1">
1728 --pickaxe-regex
1729 </dt>
1730 <dd>
1731 <p>
1732         Treat the &lt;string&gt; given to <code>-S</code> as an extended POSIX regular
1733         expression to match.
1734 </p>
1735 </dd>
1736 <dt class="hdlist1">
1737 -O&lt;orderfile&gt;
1738 </dt>
1739 <dd>
1740 <p>
1741         Control the order in which files appear in the output.
1742         This overrides the <code>diff.orderFile</code> configuration variable
1743         (see <a href="git-config.html">git-config(1)</a>).  To cancel <code>diff.orderFile</code>,
1744         use <code>-O/dev/null</code>.
1745 </p>
1746 <div class="paragraph"><p>The output order is determined by the order of glob patterns in
1747 &lt;orderfile&gt;.
1748 All files with pathnames that match the first pattern are output
1749 first, all files with pathnames that match the second pattern (but not
1750 the first) are output next, and so on.
1751 All files with pathnames that do not match any pattern are output
1752 last, as if there was an implicit match-all pattern at the end of the
1753 file.
1754 If multiple pathnames have the same rank (they match the same pattern
1755 but no earlier patterns), their output order relative to each other is
1756 the normal order.</p></div>
1757 <div class="paragraph"><p>&lt;orderfile&gt; is parsed as follows:</p></div>
1758 <div class="openblock">
1759 <div class="content">
1760 <div class="ulist"><ul>
1761 <li>
1762 <p>
1763 Blank lines are ignored, so they can be used as separators for
1764    readability.
1765 </p>
1766 </li>
1767 <li>
1768 <p>
1769 Lines starting with a hash ("<code>#</code>") are ignored, so they can be used
1770    for comments.  Add a backslash ("<code>\</code>") to the beginning of the
1771    pattern if it starts with a hash.
1772 </p>
1773 </li>
1774 <li>
1775 <p>
1776 Each other line contains a single pattern.
1777 </p>
1778 </li>
1779 </ul></div>
1780 </div></div>
1781 <div class="paragraph"><p>Patterns have the same syntax and semantics as patterns used for
1782 fnmatch(3) without the FNM_PATHNAME flag, except a pathname also
1783 matches a pattern if removing any number of the final pathname
1784 components matches the pattern.  For example, the pattern "<code>foo*bar</code>"
1785 matches "<code>fooasdfbar</code>" and "<code>foo/bar/baz/asdf</code>" but not "<code>foobarx</code>".</p></div>
1786 </dd>
1787 <dt class="hdlist1">
1788 --skip-to=&lt;file&gt;
1789 </dt>
1790 <dt class="hdlist1">
1791 --rotate-to=&lt;file&gt;
1792 </dt>
1793 <dd>
1794 <p>
1795         Discard the files before the named &lt;file&gt; from the output
1796         (i.e. <em>skip to</em>), or move them to the end of the output
1797         (i.e. <em>rotate to</em>).  These options were invented primarily for the use
1798         of the <code>git difftool</code> command, and may not be very useful
1799         otherwise.
1800 </p>
1801 </dd>
1802 <dt class="hdlist1">
1803 -R
1804 </dt>
1805 <dd>
1806 <p>
1807         Swap two inputs; that is, show differences from index or
1808         on-disk file to tree contents.
1809 </p>
1810 </dd>
1811 <dt class="hdlist1">
1812 --relative[=&lt;path&gt;]
1813 </dt>
1814 <dt class="hdlist1">
1815 --no-relative
1816 </dt>
1817 <dd>
1818 <p>
1819         When run from a subdirectory of the project, it can be
1820         told to exclude changes outside the directory and show
1821         pathnames relative to it with this option.  When you are
1822         not in a subdirectory (e.g. in a bare repository), you
1823         can name which subdirectory to make the output relative
1824         to by giving a &lt;path&gt; as an argument.
1825         <code>--no-relative</code> can be used to countermand both <code>diff.relative</code> config
1826         option and previous <code>--relative</code>.
1827 </p>
1828 </dd>
1829 <dt class="hdlist1">
1830 -a
1831 </dt>
1832 <dt class="hdlist1">
1833 --text
1834 </dt>
1835 <dd>
1836 <p>
1837         Treat all files as text.
1838 </p>
1839 </dd>
1840 <dt class="hdlist1">
1841 --ignore-cr-at-eol
1842 </dt>
1843 <dd>
1844 <p>
1845         Ignore carriage-return at the end of line when doing a comparison.
1846 </p>
1847 </dd>
1848 <dt class="hdlist1">
1849 --ignore-space-at-eol
1850 </dt>
1851 <dd>
1852 <p>
1853         Ignore changes in whitespace at EOL.
1854 </p>
1855 </dd>
1856 <dt class="hdlist1">
1857 -b
1858 </dt>
1859 <dt class="hdlist1">
1860 --ignore-space-change
1861 </dt>
1862 <dd>
1863 <p>
1864         Ignore changes in amount of whitespace.  This ignores whitespace
1865         at line end, and considers all other sequences of one or
1866         more whitespace characters to be equivalent.
1867 </p>
1868 </dd>
1869 <dt class="hdlist1">
1870 -w
1871 </dt>
1872 <dt class="hdlist1">
1873 --ignore-all-space
1874 </dt>
1875 <dd>
1876 <p>
1877         Ignore whitespace when comparing lines.  This ignores
1878         differences even if one line has whitespace where the other
1879         line has none.
1880 </p>
1881 </dd>
1882 <dt class="hdlist1">
1883 --ignore-blank-lines
1884 </dt>
1885 <dd>
1886 <p>
1887         Ignore changes whose lines are all blank.
1888 </p>
1889 </dd>
1890 <dt class="hdlist1">
1891 -I&lt;regex&gt;
1892 </dt>
1893 <dt class="hdlist1">
1894 --ignore-matching-lines=&lt;regex&gt;
1895 </dt>
1896 <dd>
1897 <p>
1898         Ignore changes whose all lines match &lt;regex&gt;.  This option may
1899         be specified more than once.
1900 </p>
1901 </dd>
1902 <dt class="hdlist1">
1903 --inter-hunk-context=&lt;lines&gt;
1904 </dt>
1905 <dd>
1906 <p>
1907         Show the context between diff hunks, up to the specified number
1908         of lines, thereby fusing hunks that are close to each other.
1909         Defaults to <code>diff.interHunkContext</code> or 0 if the config option
1910         is unset.
1911 </p>
1912 </dd>
1913 <dt class="hdlist1">
1914 -W
1915 </dt>
1916 <dt class="hdlist1">
1917 --function-context
1918 </dt>
1919 <dd>
1920 <p>
1921         Show whole function as context lines for each change.
1922         The function names are determined in the same way as
1923         <code>git diff</code> works out patch hunk headers (see <em>Defining a
1924         custom hunk-header</em> in <a href="gitattributes.html">gitattributes(5)</a>).
1925 </p>
1926 </dd>
1927 <dt class="hdlist1">
1928 --exit-code
1929 </dt>
1930 <dd>
1931 <p>
1932         Make the program exit with codes similar to diff(1).
1933         That is, it exits with 1 if there were differences and
1934         0 means no differences.
1935 </p>
1936 </dd>
1937 <dt class="hdlist1">
1938 --quiet
1939 </dt>
1940 <dd>
1941 <p>
1942         Disable all output of the program. Implies <code>--exit-code</code>.
1943 </p>
1944 </dd>
1945 <dt class="hdlist1">
1946 --ext-diff
1947 </dt>
1948 <dd>
1949 <p>
1950         Allow an external diff helper to be executed. If you set an
1951         external diff driver with <a href="gitattributes.html">gitattributes(5)</a>, you need
1952         to use this option with <a href="git-log.html">git-log(1)</a> and friends.
1953 </p>
1954 </dd>
1955 <dt class="hdlist1">
1956 --no-ext-diff
1957 </dt>
1958 <dd>
1959 <p>
1960         Disallow external diff drivers.
1961 </p>
1962 </dd>
1963 <dt class="hdlist1">
1964 --textconv
1965 </dt>
1966 <dt class="hdlist1">
1967 --no-textconv
1968 </dt>
1969 <dd>
1970 <p>
1971         Allow (or disallow) external text conversion filters to be run
1972         when comparing binary files. See <a href="gitattributes.html">gitattributes(5)</a> for
1973         details. Because textconv filters are typically a one-way
1974         conversion, the resulting diff is suitable for human
1975         consumption, but cannot be applied. For this reason, textconv
1976         filters are enabled by default only for <a href="git-diff.html">git-diff(1)</a> and
1977         <a href="git-log.html">git-log(1)</a>, but not for <a href="git-format-patch.html">git-format-patch(1)</a> or
1978         diff plumbing commands.
1979 </p>
1980 </dd>
1981 <dt class="hdlist1">
1982 --ignore-submodules[=&lt;when&gt;]
1983 </dt>
1984 <dd>
1985 <p>
1986         Ignore changes to submodules in the diff generation. &lt;when&gt; can be
1987         either "none", "untracked", "dirty" or "all", which is the default.
1988         Using "none" will consider the submodule modified when it either contains
1989         untracked or modified files or its HEAD differs from the commit recorded
1990         in the superproject and can be used to override any settings of the
1991         <em>ignore</em> option in <a href="git-config.html">git-config(1)</a> or <a href="gitmodules.html">gitmodules(5)</a>. When
1992         "untracked" is used submodules are not considered dirty when they only
1993         contain untracked content (but they are still scanned for modified
1994         content). Using "dirty" ignores all changes to the work tree of submodules,
1995         only changes to the commits stored in the superproject are shown (this was
1996         the behavior until 1.7.0). Using "all" hides all changes to submodules.
1997 </p>
1998 </dd>
1999 <dt class="hdlist1">
2000 --src-prefix=&lt;prefix&gt;
2001 </dt>
2002 <dd>
2003 <p>
2004         Show the given source prefix instead of "a/".
2005 </p>
2006 </dd>
2007 <dt class="hdlist1">
2008 --dst-prefix=&lt;prefix&gt;
2009 </dt>
2010 <dd>
2011 <p>
2012         Show the given destination prefix instead of "b/".
2013 </p>
2014 </dd>
2015 <dt class="hdlist1">
2016 --no-prefix
2017 </dt>
2018 <dd>
2019 <p>
2020         Do not show any source or destination prefix.
2021 </p>
2022 </dd>
2023 <dt class="hdlist1">
2024 --default-prefix
2025 </dt>
2026 <dd>
2027 <p>
2028         Use the default source and destination prefixes ("a/" and "b/").
2029         This is usually the default already, but may be used to override
2030         config such as <code>diff.noprefix</code>.
2031 </p>
2032 </dd>
2033 <dt class="hdlist1">
2034 --line-prefix=&lt;prefix&gt;
2035 </dt>
2036 <dd>
2037 <p>
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>
2045 <p>
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>
2062 <p>
2063         The id of a tree object.
2064 </p>
2065 </dd>
2066 <dt class="hdlist1">
2067 &lt;path&gt;&#8230;
2068 </dt>
2069 <dd>
2070 <p>
2071         If provided, the results are limited to a subset of files
2072         matching one of the provided pathspecs.
2073 </p>
2074 </dd>
2075 <dt class="hdlist1">
2076 -r
2077 </dt>
2078 <dd>
2079 <p>
2080         Recurse into sub-trees.
2081 </p>
2082 </dd>
2083 <dt class="hdlist1">
2084 -t
2085 </dt>
2086 <dd>
2087 <p>
2088         Show tree entry itself as well as subtrees.  Implies -r.
2089 </p>
2090 </dd>
2091 <dt class="hdlist1">
2092 --root
2093 </dt>
2094 <dd>
2095 <p>
2096         When <code>--root</code> is specified the initial commit will be shown as a big
2097         creation event. This is equivalent to a diff against the NULL tree.
2098 </p>
2099 </dd>
2100 <dt class="hdlist1">
2101 --merge-base
2102 </dt>
2103 <dd>
2104 <p>
2105         Instead of comparing the &lt;tree-ish&gt;s directly, use the merge
2106         base between the two &lt;tree-ish&gt;s as the "before" side.  There
2107         must be two &lt;tree-ish&gt;s given and they must both be commits.
2108 </p>
2109 </dd>
2110 <dt class="hdlist1">
2111 --stdin
2112 </dt>
2113 <dd>
2114 <p>
2115         When <code>--stdin</code> is specified, the command does not take
2116         &lt;tree-ish&gt; arguments from the command line.  Instead, it
2117         reads lines containing either two &lt;tree&gt;, one &lt;commit&gt;, or a
2118         list of &lt;commit&gt; from its standard input.  (Use a single space
2119         as separator.)
2120 </p>
2121 <div class="paragraph"><p>When two trees are given, it compares the first tree with the second.
2122 When a single commit is given, it compares the commit with its
2123 parents.  The remaining commits, when given, are used as if they are
2124 parents of the first commit.</p></div>
2125 <div class="paragraph"><p>When comparing two trees, the ID of both trees (separated by a space
2126 and terminated by a newline) is printed before the difference.  When
2127 comparing commits, the ID of the first (or only) commit, followed by a
2128 newline, is printed.</p></div>
2129 <div class="paragraph"><p>The following flags further affect the behavior when comparing
2130 commits (but not trees).</p></div>
2131 </dd>
2132 <dt class="hdlist1">
2133 -m
2134 </dt>
2135 <dd>
2136 <p>
2137         By default, <em>git diff-tree --stdin</em> does not show
2138         differences for merge commits.  With this flag, it shows
2139         differences to that commit from all of its parents. See
2140         also <code>-c</code>.
2141 </p>
2142 </dd>
2143 <dt class="hdlist1">
2144 -s
2145 </dt>
2146 <dd>
2147 <p>
2148         By default, <em>git diff-tree --stdin</em> shows differences,
2149         either in machine-readable form (without <code>-p</code>) or in patch
2150         form (with <code>-p</code>).  This output can be suppressed.  It is
2151         only useful with the <code>-v</code> flag.
2152 </p>
2153 </dd>
2154 <dt class="hdlist1">
2155 -v
2156 </dt>
2157 <dd>
2158 <p>
2159         This flag causes <em>git diff-tree --stdin</em> to also show
2160         the commit message before the differences.
2161 </p>
2162 </dd>
2163 <dt class="hdlist1">
2164 --pretty[=&lt;format&gt;]
2165 </dt>
2166 <dt class="hdlist1">
2167 --format=&lt;format&gt;
2168 </dt>
2169 <dd>
2170 <p>
2171         Pretty-print the contents of the commit logs in a given format,
2172         where <em>&lt;format&gt;</em> can be one of <em>oneline</em>, <em>short</em>, <em>medium</em>,
2173         <em>full</em>, <em>fuller</em>, <em>reference</em>, <em>email</em>, <em>raw</em>, <em>format:&lt;string&gt;</em>
2174         and <em>tformat:&lt;string&gt;</em>.  When <em>&lt;format&gt;</em> is none of the above,
2175         and has <em>%placeholder</em> in it, it acts as if
2176         <em>--pretty=tformat:&lt;format&gt;</em> were given.
2177 </p>
2178 <div class="paragraph"><p>See the "PRETTY FORMATS" section for some additional details for each
2179 format.  When <em>=&lt;format&gt;</em> part is omitted, it defaults to <em>medium</em>.</p></div>
2180 <div class="paragraph"><p>Note: you can specify the default pretty format in the repository
2181 configuration (see <a href="git-config.html">git-config(1)</a>).</p></div>
2182 </dd>
2183 <dt class="hdlist1">
2184 --abbrev-commit
2185 </dt>
2186 <dd>
2187 <p>
2188         Instead of showing the full 40-byte hexadecimal commit object
2189         name, show a prefix that names the object uniquely.
2190         "--abbrev=&lt;n&gt;" (which also modifies diff output, if it is displayed)
2191         option can be used to specify the minimum length of the prefix.
2192 </p>
2193 <div class="paragraph"><p>This should make "--pretty=oneline" a whole lot more readable for
2194 people using 80-column terminals.</p></div>
2195 </dd>
2196 <dt class="hdlist1">
2197 --no-abbrev-commit
2198 </dt>
2199 <dd>
2200 <p>
2201         Show the full 40-byte hexadecimal commit object name. This negates
2202         <code>--abbrev-commit</code>, either explicit or implied by other options such
2203         as "--oneline". It also overrides the <code>log.abbrevCommit</code> variable.
2204 </p>
2205 </dd>
2206 <dt class="hdlist1">
2207 --oneline
2208 </dt>
2209 <dd>
2210 <p>
2211         This is a shorthand for "--pretty=oneline --abbrev-commit"
2212         used together.
2213 </p>
2214 </dd>
2215 <dt class="hdlist1">
2216 --encoding=&lt;encoding&gt;
2217 </dt>
2218 <dd>
2219 <p>
2220         Commit objects record the character encoding used for the log message
2221         in their encoding header; this option can be used to tell the
2222         command to re-code the commit log message in the encoding
2223         preferred by the user.  For non plumbing commands this
2224         defaults to UTF-8. Note that if an object claims to be encoded
2225         in <code>X</code> and we are outputting in <code>X</code>, we will output the object
2226         verbatim; this means that invalid sequences in the original
2227         commit may be copied to the output. Likewise, if iconv(3) fails
2228         to convert the commit, we will quietly output the original
2229         object verbatim.
2230 </p>
2231 </dd>
2232 <dt class="hdlist1">
2233 --expand-tabs=&lt;n&gt;
2234 </dt>
2235 <dt class="hdlist1">
2236 --expand-tabs
2237 </dt>
2238 <dt class="hdlist1">
2239 --no-expand-tabs
2240 </dt>
2241 <dd>
2242 <p>
2243         Perform a tab expansion (replace each tab with enough spaces
2244         to fill to the next display column that is a multiple of <em>&lt;n&gt;</em>)
2245         in the log message before showing it in the output.
2246         <code>--expand-tabs</code> is a short-hand for <code>--expand-tabs=8</code>, and
2247         <code>--no-expand-tabs</code> is a short-hand for <code>--expand-tabs=0</code>,
2248         which disables tab expansion.
2249 </p>
2250 <div class="paragraph"><p>By default, tabs are expanded in pretty formats that indent the log
2251 message by 4 spaces (i.e.  <em>medium</em>, which is the default, <em>full</em>,
2252 and <em>fuller</em>).</p></div>
2253 </dd>
2254 <dt class="hdlist1">
2255 --notes[=&lt;ref&gt;]
2256 </dt>
2257 <dd>
2258 <p>
2259         Show the notes (see <a href="git-notes.html">git-notes(1)</a>) that annotate the
2260         commit, when showing the commit log message.  This is the default
2261         for <code>git log</code>, <code>git show</code> and <code>git whatchanged</code> commands when
2262         there is no <code>--pretty</code>, <code>--format</code>, or <code>--oneline</code> option given
2263         on the command line.
2264 </p>
2265 <div class="paragraph"><p>By default, the notes shown are from the notes refs listed in the
2266 <code>core.notesRef</code> and <code>notes.displayRef</code> variables (or corresponding
2267 environment overrides). See <a href="git-config.html">git-config(1)</a> for more details.</p></div>
2268 <div class="paragraph"><p>With an optional <em>&lt;ref&gt;</em> argument, use the ref to find the notes
2269 to display.  The ref can specify the full refname when it begins
2270 with <code>refs/notes/</code>; when it begins with <code>notes/</code>, <code>refs/</code> and otherwise
2271 <code>refs/notes/</code> is prefixed to form the full name of the ref.</p></div>
2272 <div class="paragraph"><p>Multiple --notes options can be combined to control which notes are
2273 being displayed. Examples: "--notes=foo" will show only notes from
2274 "refs/notes/foo"; "--notes=foo --notes" will show both notes from
2275 "refs/notes/foo" and from the default notes ref(s).</p></div>
2276 </dd>
2277 <dt class="hdlist1">
2278 --no-notes
2279 </dt>
2280 <dd>
2281 <p>
2282         Do not show notes. This negates the above <code>--notes</code> option, by
2283         resetting the list of notes refs from which notes are shown.
2284         Options are parsed in the order given on the command line, so e.g.
2285         "--notes --notes=foo --no-notes --notes=bar" will only show notes
2286         from "refs/notes/bar".
2287 </p>
2288 </dd>
2289 <dt class="hdlist1">
2290 --show-notes-by-default
2291 </dt>
2292 <dd>
2293 <p>
2294         Show the default notes unless options for displaying specific
2295         notes are given.
2296 </p>
2297 </dd>
2298 <dt class="hdlist1">
2299 --show-notes[=&lt;ref&gt;]
2300 </dt>
2301 <dt class="hdlist1">
2302 --[no-]standard-notes
2303 </dt>
2304 <dd>
2305 <p>
2306         These options are deprecated. Use the above --notes/--no-notes
2307         options instead.
2308 </p>
2309 </dd>
2310 <dt class="hdlist1">
2311 --show-signature
2312 </dt>
2313 <dd>
2314 <p>
2315         Check the validity of a signed commit object by passing the signature
2316         to <code>gpg --verify</code> and show the output.
2317 </p>
2318 </dd>
2319 <dt class="hdlist1">
2320 --no-commit-id
2321 </dt>
2322 <dd>
2323 <p>
2324         <em>git diff-tree</em> outputs a line with the commit ID when
2325         applicable.  This flag suppressed the commit ID output.
2326 </p>
2327 </dd>
2328 <dt class="hdlist1">
2329 -c
2330 </dt>
2331 <dd>
2332 <p>
2333         This flag changes the way a merge commit is displayed
2334         (which means it is useful only when the command is given
2335         one &lt;tree-ish&gt;, or <code>--stdin</code>).  It shows the differences
2336         from each of the parents to the merge result simultaneously
2337         instead of showing pairwise diff between a parent and the
2338         result one at a time (which is what the <code>-m</code> option does).
2339         Furthermore, it lists only files which were modified
2340         from all parents.
2341 </p>
2342 </dd>
2343 <dt class="hdlist1">
2344 --cc
2345 </dt>
2346 <dd>
2347 <p>
2348         This flag changes the way a merge commit patch is displayed,
2349         in a similar way to the <code>-c</code> option. It implies the <code>-c</code>
2350         and <code>-p</code> options and further compresses the patch output
2351         by omitting uninteresting hunks whose contents in the parents
2352         have only two variants and the merge result picks one of them
2353         without modification.  When all hunks are uninteresting, the commit
2354         itself and the commit log message are not shown, just like in any other
2355         "empty diff" case.
2356 </p>
2357 </dd>
2358 <dt class="hdlist1">
2359 --combined-all-paths
2360 </dt>
2361 <dd>
2362 <p>
2363         This flag causes combined diffs (used for merge commits) to
2364         list the name of the file from all parents.  It thus only has
2365         effect when -c or --cc are specified, and is likely only
2366         useful if filename changes are detected (i.e. when either
2367         rename or copy detection have been requested).
2368 </p>
2369 </dd>
2370 <dt class="hdlist1">
2371 --always
2372 </dt>
2373 <dd>
2374 <p>
2375         Show the commit itself and the commit log message even
2376         if the diff itself is empty.
2377 </p>
2378 </dd>
2379 </dl></div>
2380 </div>
2381 </div>
2382 <div class="sect1">
2383 <h2 id="_pretty_formats">PRETTY FORMATS</h2>
2384 <div class="sectionbody">
2385 <div class="paragraph"><p>If the commit is a merge, and if the pretty-format
2386 is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is
2387 inserted before the <em>Author:</em> line.  This line begins with
2388 "Merge: " and the hashes of ancestral commits are printed,
2389 separated by spaces.  Note that the listed commits may not
2390 necessarily be the list of the <strong>direct</strong> parent commits if you
2391 have limited your view of history: for example, if you are
2392 only interested in changes related to a certain directory or
2393 file.</p></div>
2394 <div class="paragraph"><p>There are several built-in formats, and you can define
2395 additional formats by setting a pretty.&lt;name&gt;
2396 config option to either another format name, or a
2397 <em>format:</em> string, as described below (see
2398 <a href="git-config.html">git-config(1)</a>). Here are the details of the
2399 built-in formats:</p></div>
2400 <div class="ulist"><ul>
2401 <li>
2402 <p>
2403 <em>oneline</em>
2404 </p>
2405 <div class="literalblock">
2406 <div class="content">
2407 <pre><code>&lt;hash&gt; &lt;title-line&gt;</code></pre>
2408 </div></div>
2409 <div class="paragraph"><p>This is designed to be as compact as possible.</p></div>
2410 </li>
2411 <li>
2412 <p>
2413 <em>short</em>
2414 </p>
2415 <div class="literalblock">
2416 <div class="content">
2417 <pre><code>commit &lt;hash&gt;
2418 Author: &lt;author&gt;</code></pre>
2419 </div></div>
2420 <div class="literalblock">
2421 <div class="content">
2422 <pre><code>&lt;title-line&gt;</code></pre>
2423 </div></div>
2424 </li>
2425 <li>
2426 <p>
2427 <em>medium</em>
2428 </p>
2429 <div class="literalblock">
2430 <div class="content">
2431 <pre><code>commit &lt;hash&gt;
2432 Author: &lt;author&gt;
2433 Date:   &lt;author-date&gt;</code></pre>
2434 </div></div>
2435 <div class="literalblock">
2436 <div class="content">
2437 <pre><code>&lt;title-line&gt;</code></pre>
2438 </div></div>
2439 <div class="literalblock">
2440 <div class="content">
2441 <pre><code>&lt;full-commit-message&gt;</code></pre>
2442 </div></div>
2443 </li>
2444 <li>
2445 <p>
2446 <em>full</em>
2447 </p>
2448 <div class="literalblock">
2449 <div class="content">
2450 <pre><code>commit &lt;hash&gt;
2451 Author: &lt;author&gt;
2452 Commit: &lt;committer&gt;</code></pre>
2453 </div></div>
2454 <div class="literalblock">
2455 <div class="content">
2456 <pre><code>&lt;title-line&gt;</code></pre>
2457 </div></div>
2458 <div class="literalblock">
2459 <div class="content">
2460 <pre><code>&lt;full-commit-message&gt;</code></pre>
2461 </div></div>
2462 </li>
2463 <li>
2464 <p>
2465 <em>fuller</em>
2466 </p>
2467 <div class="literalblock">
2468 <div class="content">
2469 <pre><code>commit &lt;hash&gt;
2470 Author:     &lt;author&gt;
2471 AuthorDate: &lt;author-date&gt;
2472 Commit:     &lt;committer&gt;
2473 CommitDate: &lt;committer-date&gt;</code></pre>
2474 </div></div>
2475 <div class="literalblock">
2476 <div class="content">
2477 <pre><code>&lt;title-line&gt;</code></pre>
2478 </div></div>
2479 <div class="literalblock">
2480 <div class="content">
2481 <pre><code>&lt;full-commit-message&gt;</code></pre>
2482 </div></div>
2483 </li>
2484 <li>
2485 <p>
2486 <em>reference</em>
2487 </p>
2488 <div class="literalblock">
2489 <div class="content">
2490 <pre><code>&lt;abbrev-hash&gt; (&lt;title-line&gt;, &lt;short-author-date&gt;)</code></pre>
2491 </div></div>
2492 <div class="paragraph"><p>This format is used to refer to another commit in a commit message and
2493 is the same as <code>--pretty='format:%C(auto)%h (%s, %ad)'</code>.  By default,
2494 the date is formatted with <code>--date=short</code> unless another <code>--date</code> option
2495 is explicitly specified.  As with any <code>format:</code> with format
2496 placeholders, its output is not affected by other options like
2497 <code>--decorate</code> and <code>--walk-reflogs</code>.</p></div>
2498 </li>
2499 <li>
2500 <p>
2501 <em>email</em>
2502 </p>
2503 <div class="literalblock">
2504 <div class="content">
2505 <pre><code>From &lt;hash&gt; &lt;date&gt;
2506 From: &lt;author&gt;
2507 Date: &lt;author-date&gt;
2508 Subject: [PATCH] &lt;title-line&gt;</code></pre>
2509 </div></div>
2510 <div class="literalblock">
2511 <div class="content">
2512 <pre><code>&lt;full-commit-message&gt;</code></pre>
2513 </div></div>
2514 </li>
2515 <li>
2516 <p>
2517 <em>mboxrd</em>
2518 </p>
2519 <div class="paragraph"><p>Like <em>email</em>, but lines in the commit message starting with "From "
2520 (preceded by zero or more "&gt;") are quoted with "&gt;" so they aren&#8217;t
2521 confused as starting a new commit.</p></div>
2522 </li>
2523 <li>
2524 <p>
2525 <em>raw</em>
2526 </p>
2527 <div class="paragraph"><p>The <em>raw</em> format shows the entire commit exactly as
2528 stored in the commit object.  Notably, the hashes are
2529 displayed in full, regardless of whether --abbrev or
2530 --no-abbrev are used, and <em>parents</em> information show the
2531 true parent commits, without taking grafts or history
2532 simplification into account. Note that this format affects the way
2533 commits are displayed, but not the way the diff is shown e.g. with
2534 <code>git log --raw</code>. To get full object names in a raw diff format,
2535 use <code>--no-abbrev</code>.</p></div>
2536 </li>
2537 <li>
2538 <p>
2539 <em>format:&lt;format-string&gt;</em>
2540 </p>
2541 <div class="paragraph"><p>The <em>format:&lt;format-string&gt;</em> format allows you to specify which information
2542 you want to show. It works a little bit like printf format,
2543 with the notable exception that you get a newline with <em>%n</em>
2544 instead of <em>\n</em>.</p></div>
2545 <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>
2546 would show something like this:</p></div>
2547 <div class="listingblock">
2548 <div class="content">
2549 <pre><code>The author of fe6e0ee was Junio C Hamano, 23 hours ago
2550 The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;</code></pre>
2551 </div></div>
2552 <div class="paragraph"><p>The placeholders are:</p></div>
2553 <div class="ulist"><ul>
2554 <li>
2555 <p>
2556 Placeholders that expand to a single literal character:
2557 </p>
2558 <div class="dlist"><dl>
2559 <dt class="hdlist1">
2560 <em>%n</em>
2561 </dt>
2562 <dd>
2563 <p>
2564 newline
2565 </p>
2566 </dd>
2567 <dt class="hdlist1">
2568 <em>%%</em>
2569 </dt>
2570 <dd>
2571 <p>
2572 a raw <em>%</em>
2573 </p>
2574 </dd>
2575 <dt class="hdlist1">
2576 <em>%x00</em>
2577 </dt>
2578 <dd>
2579 <p>
2580 <em>%x</em> followed by two hexadecimal digits is replaced with a
2581          byte with the hexadecimal digits' value (we will call this
2582          "literal formatting code" in the rest of this document).
2583 </p>
2584 </dd>
2585 </dl></div>
2586 </li>
2587 <li>
2588 <p>
2589 Placeholders that affect formatting of later placeholders:
2590 </p>
2591 <div class="dlist"><dl>
2592 <dt class="hdlist1">
2593 <em>%Cred</em>
2594 </dt>
2595 <dd>
2596 <p>
2597 switch color to red
2598 </p>
2599 </dd>
2600 <dt class="hdlist1">
2601 <em>%Cgreen</em>
2602 </dt>
2603 <dd>
2604 <p>
2605 switch color to green
2606 </p>
2607 </dd>
2608 <dt class="hdlist1">
2609 <em>%Cblue</em>
2610 </dt>
2611 <dd>
2612 <p>
2613 switch color to blue
2614 </p>
2615 </dd>
2616 <dt class="hdlist1">
2617 <em>%Creset</em>
2618 </dt>
2619 <dd>
2620 <p>
2621 reset color
2622 </p>
2623 </dd>
2624 <dt class="hdlist1">
2625 <em>%C(&#8230;)</em>
2626 </dt>
2627 <dd>
2628 <p>
2629 color specification, as described under Values in the
2630             "CONFIGURATION FILE" section of <a href="git-config.html">git-config(1)</a>.  By
2631             default, colors are shown only when enabled for log output
2632             (by <code>color.diff</code>, <code>color.ui</code>, or <code>--color</code>, and respecting
2633             the <code>auto</code> settings of the former if we are going to a
2634             terminal). <code>%C(auto,...)</code> is accepted as a historical
2635             synonym for the default (e.g., <code>%C(auto,red)</code>). Specifying
2636             <code>%C(always,...)</code> will show the colors even when color is
2637             not otherwise enabled (though consider just using
2638             <code>--color=always</code> to enable color for the whole output,
2639             including this format and anything else git might color).
2640             <code>auto</code> alone (i.e. <code>%C(auto)</code>) will turn on auto coloring
2641             on the next placeholders until the color is switched
2642             again.
2643 </p>
2644 </dd>
2645 <dt class="hdlist1">
2646 <em>%m</em>
2647 </dt>
2648 <dd>
2649 <p>
2650 left (<code>&lt;</code>), right (<code>&gt;</code>) or boundary (<code>-</code>) mark
2651 </p>
2652 </dd>
2653 <dt class="hdlist1">
2654 <em>%w([&lt;w&gt;[,&lt;i1&gt;[,&lt;i2&gt;]]])</em>
2655 </dt>
2656 <dd>
2657 <p>
2658 switch line wrapping, like the -w option of
2659                             <a href="git-shortlog.html">git-shortlog(1)</a>.
2660 </p>
2661 </dd>
2662 <dt class="hdlist1">
2663 <em>%&lt;( &lt;N&gt; [,trunc|ltrunc|mtrunc])</em>
2664 </dt>
2665 <dd>
2666 <p>
2667 make the next placeholder take at
2668                                   least N column widths, padding spaces on
2669                                   the right if necessary.  Optionally
2670                                   truncate (with ellipsis <em>..</em>) at the left (ltrunc) <code>..ft</code>,
2671                                   the middle (mtrunc) <code>mi..le</code>, or the end
2672                                   (trunc) <code>rig..</code>, if the output is longer than
2673                                   N columns.
2674                                   Note 1: that truncating
2675                                   only works correctly with N &gt;= 2.
2676                                   Note 2: spaces around the N and M (see below)
2677                                   values are optional.
2678                                   Note 3: Emojis and other wide characters
2679                                   will take two display columns, which may
2680                                   over-run column boundaries.
2681                                   Note 4: decomposed character combining marks
2682                                   may be misplaced at padding boundaries.
2683 </p>
2684 </dd>
2685 <dt class="hdlist1">
2686 <em>%&lt;|( &lt;M&gt; )</em>
2687 </dt>
2688 <dd>
2689 <p>
2690 make the next placeholder take at least until Mth
2691              display column, padding spaces on the right if necessary.
2692              Use negative M values for column positions measured
2693              from the right hand edge of the terminal window.
2694 </p>
2695 </dd>
2696 <dt class="hdlist1">
2697 <em>%&gt;( &lt;N&gt; )</em>, <em>%&gt;|( &lt;M&gt; )</em>
2698 </dt>
2699 <dd>
2700 <p>
2701 similar to <em>%&lt;( &lt;N&gt; )</em>, <em>%&lt;|( &lt;M&gt; )</em> respectively,
2702                         but padding spaces on the left
2703 </p>
2704 </dd>
2705 <dt class="hdlist1">
2706 <em>%&gt;&gt;( &lt;N&gt; )</em>, <em>%&gt;&gt;|( &lt;M&gt; )</em>
2707 </dt>
2708 <dd>
2709 <p>
2710 similar to <em>%&gt;( &lt;N&gt; )</em>, <em>%&gt;|( &lt;M&gt; )</em>
2711                           respectively, except that if the next
2712                           placeholder takes more spaces than given and
2713                           there are spaces on its left, use those
2714                           spaces
2715 </p>
2716 </dd>
2717 <dt class="hdlist1">
2718 <em>%&gt;&lt;( &lt;N&gt; )</em>, <em>%&gt;&lt;|( &lt;M&gt; )</em>
2719 </dt>
2720 <dd>
2721 <p>
2722 similar to <em>%&lt;( &lt;N&gt; )</em>, <em>%&lt;|( &lt;M&gt; )</em>
2723                           respectively, but padding both sides
2724                           (i.e. the text is centered)
2725 </p>
2726 </dd>
2727 </dl></div>
2728 </li>
2729 <li>
2730 <p>
2731 Placeholders that expand to information extracted from the commit:
2732 </p>
2733 <div class="dlist"><dl>
2734 <dt class="hdlist1">
2735 <em>%H</em>
2736 </dt>
2737 <dd>
2738 <p>
2739 commit hash
2740 </p>
2741 </dd>
2742 <dt class="hdlist1">
2743 <em>%h</em>
2744 </dt>
2745 <dd>
2746 <p>
2747 abbreviated commit hash
2748 </p>
2749 </dd>
2750 <dt class="hdlist1">
2751 <em>%T</em>
2752 </dt>
2753 <dd>
2754 <p>
2755 tree hash
2756 </p>
2757 </dd>
2758 <dt class="hdlist1">
2759 <em>%t</em>
2760 </dt>
2761 <dd>
2762 <p>
2763 abbreviated tree hash
2764 </p>
2765 </dd>
2766 <dt class="hdlist1">
2767 <em>%P</em>
2768 </dt>
2769 <dd>
2770 <p>
2771 parent hashes
2772 </p>
2773 </dd>
2774 <dt class="hdlist1">
2775 <em>%p</em>
2776 </dt>
2777 <dd>
2778 <p>
2779 abbreviated parent hashes
2780 </p>
2781 </dd>
2782 <dt class="hdlist1">
2783 <em>%an</em>
2784 </dt>
2785 <dd>
2786 <p>
2787 author name
2788 </p>
2789 </dd>
2790 <dt class="hdlist1">
2791 <em>%aN</em>
2792 </dt>
2793 <dd>
2794 <p>
2795 author name (respecting .mailmap, see <a href="git-shortlog.html">git-shortlog(1)</a>
2796         or <a href="git-blame.html">git-blame(1)</a>)
2797 </p>
2798 </dd>
2799 <dt class="hdlist1">
2800 <em>%ae</em>
2801 </dt>
2802 <dd>
2803 <p>
2804 author email
2805 </p>
2806 </dd>
2807 <dt class="hdlist1">
2808 <em>%aE</em>
2809 </dt>
2810 <dd>
2811 <p>
2812 author email (respecting .mailmap, see <a href="git-shortlog.html">git-shortlog(1)</a>
2813         or <a href="git-blame.html">git-blame(1)</a>)
2814 </p>
2815 </dd>
2816 <dt class="hdlist1">
2817 <em>%al</em>
2818 </dt>
2819 <dd>
2820 <p>
2821 author email local-part (the part before the <em>@</em> sign)
2822 </p>
2823 </dd>
2824 <dt class="hdlist1">
2825 <em>%aL</em>
2826 </dt>
2827 <dd>
2828 <p>
2829 author local-part (see <em>%al</em>) respecting .mailmap, see
2830         <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
2831 </p>
2832 </dd>
2833 <dt class="hdlist1">
2834 <em>%ad</em>
2835 </dt>
2836 <dd>
2837 <p>
2838 author date (format respects --date= option)
2839 </p>
2840 </dd>
2841 <dt class="hdlist1">
2842 <em>%aD</em>
2843 </dt>
2844 <dd>
2845 <p>
2846 author date, RFC2822 style
2847 </p>
2848 </dd>
2849 <dt class="hdlist1">
2850 <em>%ar</em>
2851 </dt>
2852 <dd>
2853 <p>
2854 author date, relative
2855 </p>
2856 </dd>
2857 <dt class="hdlist1">
2858 <em>%at</em>
2859 </dt>
2860 <dd>
2861 <p>
2862 author date, UNIX timestamp
2863 </p>
2864 </dd>
2865 <dt class="hdlist1">
2866 <em>%ai</em>
2867 </dt>
2868 <dd>
2869 <p>
2870 author date, ISO 8601-like format
2871 </p>
2872 </dd>
2873 <dt class="hdlist1">
2874 <em>%aI</em>
2875 </dt>
2876 <dd>
2877 <p>
2878 author date, strict ISO 8601 format
2879 </p>
2880 </dd>
2881 <dt class="hdlist1">
2882 <em>%as</em>
2883 </dt>
2884 <dd>
2885 <p>
2886 author date, short format (<code>YYYY-MM-DD</code>)
2887 </p>
2888 </dd>
2889 <dt class="hdlist1">
2890 <em>%ah</em>
2891 </dt>
2892 <dd>
2893 <p>
2894 author date, human style (like the <code>--date=human</code> option of
2895         <a href="git-rev-list.html">git-rev-list(1)</a>)
2896 </p>
2897 </dd>
2898 <dt class="hdlist1">
2899 <em>%cn</em>
2900 </dt>
2901 <dd>
2902 <p>
2903 committer name
2904 </p>
2905 </dd>
2906 <dt class="hdlist1">
2907 <em>%cN</em>
2908 </dt>
2909 <dd>
2910 <p>
2911 committer name (respecting .mailmap, see
2912         <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
2913 </p>
2914 </dd>
2915 <dt class="hdlist1">
2916 <em>%ce</em>
2917 </dt>
2918 <dd>
2919 <p>
2920 committer email
2921 </p>
2922 </dd>
2923 <dt class="hdlist1">
2924 <em>%cE</em>
2925 </dt>
2926 <dd>
2927 <p>
2928 committer email (respecting .mailmap, see
2929         <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
2930 </p>
2931 </dd>
2932 <dt class="hdlist1">
2933 <em>%cl</em>
2934 </dt>
2935 <dd>
2936 <p>
2937 committer email local-part (the part before the <em>@</em> sign)
2938 </p>
2939 </dd>
2940 <dt class="hdlist1">
2941 <em>%cL</em>
2942 </dt>
2943 <dd>
2944 <p>
2945 committer local-part (see <em>%cl</em>) respecting .mailmap, see
2946         <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
2947 </p>
2948 </dd>
2949 <dt class="hdlist1">
2950 <em>%cd</em>
2951 </dt>
2952 <dd>
2953 <p>
2954 committer date (format respects --date= option)
2955 </p>
2956 </dd>
2957 <dt class="hdlist1">
2958 <em>%cD</em>
2959 </dt>
2960 <dd>
2961 <p>
2962 committer date, RFC2822 style
2963 </p>
2964 </dd>
2965 <dt class="hdlist1">
2966 <em>%cr</em>
2967 </dt>
2968 <dd>
2969 <p>
2970 committer date, relative
2971 </p>
2972 </dd>
2973 <dt class="hdlist1">
2974 <em>%ct</em>
2975 </dt>
2976 <dd>
2977 <p>
2978 committer date, UNIX timestamp
2979 </p>
2980 </dd>
2981 <dt class="hdlist1">
2982 <em>%ci</em>
2983 </dt>
2984 <dd>
2985 <p>
2986 committer date, ISO 8601-like format
2987 </p>
2988 </dd>
2989 <dt class="hdlist1">
2990 <em>%cI</em>
2991 </dt>
2992 <dd>
2993 <p>
2994 committer date, strict ISO 8601 format
2995 </p>
2996 </dd>
2997 <dt class="hdlist1">
2998 <em>%cs</em>
2999 </dt>
3000 <dd>
3001 <p>
3002 committer date, short format (<code>YYYY-MM-DD</code>)
3003 </p>
3004 </dd>
3005 <dt class="hdlist1">
3006 <em>%ch</em>
3007 </dt>
3008 <dd>
3009 <p>
3010 committer date, human style (like the <code>--date=human</code> option of
3011         <a href="git-rev-list.html">git-rev-list(1)</a>)
3012 </p>
3013 </dd>
3014 <dt class="hdlist1">
3015 <em>%d</em>
3016 </dt>
3017 <dd>
3018 <p>
3019 ref names, like the --decorate option of <a href="git-log.html">git-log(1)</a>
3020 </p>
3021 </dd>
3022 <dt class="hdlist1">
3023 <em>%D</em>
3024 </dt>
3025 <dd>
3026 <p>
3027 ref names without the " (", ")" wrapping.
3028 </p>
3029 </dd>
3030 <dt class="hdlist1">
3031 <em>%(decorate[:&lt;options&gt;])</em>
3032 </dt>
3033 <dd>
3034 <p>
3035 ref names with custom decorations. The <code>decorate</code> string may be followed by a
3036 colon and zero or more comma-separated options. Option values may contain
3037 literal formatting codes. These must be used for commas (<code>%x2C</code>) and closing
3038 parentheses (<code>%x29</code>), due to their role in the option syntax.
3039 </p>
3040 <div class="ulist"><ul>
3041 <li>
3042 <p>
3043 <em>prefix=&lt;value&gt;</em>: Shown before the list of ref names.  Defaults to "&#160;<code>(</code>".
3044 </p>
3045 </li>
3046 <li>
3047 <p>
3048 <em>suffix=&lt;value&gt;</em>: Shown after the list of ref names.  Defaults to "<code>)</code>".
3049 </p>
3050 </li>
3051 <li>
3052 <p>
3053 <em>separator=&lt;value&gt;</em>: Shown between ref names.  Defaults to "<code>,</code>&#160;".
3054 </p>
3055 </li>
3056 <li>
3057 <p>
3058 <em>pointer=&lt;value&gt;</em>: Shown between HEAD and the branch it points to, if any.
3059                       Defaults to "&#160;<code>-&gt;</code>&#160;".
3060 </p>
3061 </li>
3062 <li>
3063 <p>
3064 <em>tag=&lt;value&gt;</em>: Shown before tag names. Defaults to "<code>tag:</code>&#160;".
3065 </p>
3066 </li>
3067 </ul></div>
3068 <div class="paragraph"><p>For example, to produce decorations with no wrapping
3069 or tag annotations, and spaces as separators:</p></div>
3070 <div class="paragraph"><p><code>%(decorate:prefix=,suffix=,tag=,separator= )</code></p></div>
3071 </dd>
3072 <dt class="hdlist1">
3073 <em>%(describe[:&lt;options&gt;])</em>
3074 </dt>
3075 <dd>
3076 <p>
3077 human-readable name, like <a href="git-describe.html">git-describe(1)</a>; empty string for
3078 undescribable commits.  The <code>describe</code> string may be followed by a colon and
3079 zero or more comma-separated options.  Descriptions can be inconsistent when
3080 tags are added or removed at the same time.
3081 </p>
3082 <div class="ulist"><ul>
3083 <li>
3084 <p>
3085 <em>tags[=&lt;bool-value&gt;]</em>: Instead of only considering annotated tags,
3086    consider lightweight tags as well.
3087 </p>
3088 </li>
3089 <li>
3090 <p>
3091 <em>abbrev=&lt;number&gt;</em>: Instead of using the default number of hexadecimal digits
3092    (which will vary according to the number of objects in the repository with a
3093    default of 7) of the abbreviated object name, use &lt;number&gt; digits, or as many
3094    digits as needed to form a unique object name.
3095 </p>
3096 </li>
3097 <li>
3098 <p>
3099 <em>match=&lt;pattern&gt;</em>: Only consider tags matching the given
3100    <code>glob(7)</code> pattern, excluding the "refs/tags/" prefix.
3101 </p>
3102 </li>
3103 <li>
3104 <p>
3105 <em>exclude=&lt;pattern&gt;</em>: Do not consider tags matching the given
3106    <code>glob(7)</code> pattern, excluding the "refs/tags/" prefix.
3107 </p>
3108 </li>
3109 </ul></div>
3110 </dd>
3111 <dt class="hdlist1">
3112 <em>%S</em>
3113 </dt>
3114 <dd>
3115 <p>
3116 ref name given on the command line by which the commit was reached
3117        (like <code>git log --source</code>), only works with <code>git log</code>
3118 </p>
3119 </dd>
3120 <dt class="hdlist1">
3121 <em>%e</em>
3122 </dt>
3123 <dd>
3124 <p>
3125 encoding
3126 </p>
3127 </dd>
3128 <dt class="hdlist1">
3129 <em>%s</em>
3130 </dt>
3131 <dd>
3132 <p>
3133 subject
3134 </p>
3135 </dd>
3136 <dt class="hdlist1">
3137 <em>%f</em>
3138 </dt>
3139 <dd>
3140 <p>
3141 sanitized subject line, suitable for a filename
3142 </p>
3143 </dd>
3144 <dt class="hdlist1">
3145 <em>%b</em>
3146 </dt>
3147 <dd>
3148 <p>
3149 body
3150 </p>
3151 </dd>
3152 <dt class="hdlist1">
3153 <em>%B</em>
3154 </dt>
3155 <dd>
3156 <p>
3157 raw body (unwrapped subject and body)
3158 </p>
3159 </dd>
3160 <dt class="hdlist1">
3161 <em>%N</em>
3162 </dt>
3163 <dd>
3164 <p>
3165 commit notes
3166 </p>
3167 </dd>
3168 <dt class="hdlist1">
3169 <em>%GG</em>
3170 </dt>
3171 <dd>
3172 <p>
3173 raw verification message from GPG for a signed commit
3174 </p>
3175 </dd>
3176 <dt class="hdlist1">
3177 <em>%G?</em>
3178 </dt>
3179 <dd>
3180 <p>
3181 show "G" for a good (valid) signature,
3182         "B" for a bad signature,
3183         "U" for a good signature with unknown validity,
3184         "X" for a good signature that has expired,
3185         "Y" for a good signature made by an expired key,
3186         "R" for a good signature made by a revoked key,
3187         "E" if the signature cannot be checked (e.g. missing key)
3188         and "N" for no signature
3189 </p>
3190 </dd>
3191 <dt class="hdlist1">
3192 <em>%GS</em>
3193 </dt>
3194 <dd>
3195 <p>
3196 show the name of the signer for a signed commit
3197 </p>
3198 </dd>
3199 <dt class="hdlist1">
3200 <em>%GK</em>
3201 </dt>
3202 <dd>
3203 <p>
3204 show the key used to sign a signed commit
3205 </p>
3206 </dd>
3207 <dt class="hdlist1">
3208 <em>%GF</em>
3209 </dt>
3210 <dd>
3211 <p>
3212 show the fingerprint of the key used to sign a signed commit
3213 </p>
3214 </dd>
3215 <dt class="hdlist1">
3216 <em>%GP</em>
3217 </dt>
3218 <dd>
3219 <p>
3220 show the fingerprint of the primary key whose subkey was used
3221         to sign a signed commit
3222 </p>
3223 </dd>
3224 <dt class="hdlist1">
3225 <em>%GT</em>
3226 </dt>
3227 <dd>
3228 <p>
3229 show the trust level for the key used to sign a signed commit
3230 </p>
3231 </dd>
3232 <dt class="hdlist1">
3233 <em>%gD</em>
3234 </dt>
3235 <dd>
3236 <p>
3237 reflog selector, e.g., <code>refs/stash@{1}</code> or <code>refs/stash@{2
3238         minutes ago}</code>; the format follows the rules described for the
3239         <code>-g</code> option. The portion before the <code>@</code> is the refname as
3240         given on the command line (so <code>git log -g refs/heads/master</code>
3241         would yield <code>refs/heads/master@{0}</code>).
3242 </p>
3243 </dd>
3244 <dt class="hdlist1">
3245 <em>%gd</em>
3246 </dt>
3247 <dd>
3248 <p>
3249 shortened reflog selector; same as <code>%gD</code>, but the refname
3250         portion is shortened for human readability (so
3251         <code>refs/heads/master</code> becomes just <code>master</code>).
3252 </p>
3253 </dd>
3254 <dt class="hdlist1">
3255 <em>%gn</em>
3256 </dt>
3257 <dd>
3258 <p>
3259 reflog identity name
3260 </p>
3261 </dd>
3262 <dt class="hdlist1">
3263 <em>%gN</em>
3264 </dt>
3265 <dd>
3266 <p>
3267 reflog identity name (respecting .mailmap, see
3268         <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3269 </p>
3270 </dd>
3271 <dt class="hdlist1">
3272 <em>%ge</em>
3273 </dt>
3274 <dd>
3275 <p>
3276 reflog identity email
3277 </p>
3278 </dd>
3279 <dt class="hdlist1">
3280 <em>%gE</em>
3281 </dt>
3282 <dd>
3283 <p>
3284 reflog identity email (respecting .mailmap, see
3285         <a href="git-shortlog.html">git-shortlog(1)</a> or <a href="git-blame.html">git-blame(1)</a>)
3286 </p>
3287 </dd>
3288 <dt class="hdlist1">
3289 <em>%gs</em>
3290 </dt>
3291 <dd>
3292 <p>
3293 reflog subject
3294 </p>
3295 </dd>
3296 <dt class="hdlist1">
3297 <em>%(trailers[:&lt;options&gt;])</em>
3298 </dt>
3299 <dd>
3300 <p>
3301 display the trailers of the body as interpreted by
3302 <a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>. The <code>trailers</code> string may be followed by
3303 a colon and zero or more comma-separated options. If any option is provided
3304 multiple times, the last occurrence wins.
3305 </p>
3306 <div class="ulist"><ul>
3307 <li>
3308 <p>
3309 <em>key=&lt;key&gt;</em>: only show trailers with specified &lt;key&gt;. Matching is done
3310    case-insensitively and trailing colon is optional. If option is
3311    given multiple times trailer lines matching any of the keys are
3312    shown. This option automatically enables the <code>only</code> option so that
3313    non-trailer lines in the trailer block are hidden. If that is not
3314    desired it can be disabled with <code>only=false</code>.  E.g.,
3315    <code>%(trailers:key=Reviewed-by)</code> shows trailer lines with key
3316    <code>Reviewed-by</code>.
3317 </p>
3318 </li>
3319 <li>
3320 <p>
3321 <em>only[=&lt;bool&gt;]</em>: select whether non-trailer lines from the trailer
3322    block should be included.
3323 </p>
3324 </li>
3325 <li>
3326 <p>
3327 <em>separator=&lt;sep&gt;</em>: specify a separator inserted between trailer
3328    lines. When this option is not given each trailer line is
3329    terminated with a line feed character. The string &lt;sep&gt; may contain
3330    the literal formatting codes described above. To use comma as
3331    separator one must use <code>%x2C</code> as it would otherwise be parsed as
3332    next option. E.g., <code>%(trailers:key=Ticket,separator=%x2C )</code>
3333    shows all trailer lines whose key is "Ticket" separated by a comma
3334    and a space.
3335 </p>
3336 </li>
3337 <li>
3338 <p>
3339 <em>unfold[=&lt;bool&gt;]</em>: make it behave as if interpret-trailer&#8217;s <code>--unfold</code>
3340    option was given. E.g.,
3341    <code>%(trailers:only,unfold=true)</code> unfolds and shows all trailer lines.
3342 </p>
3343 </li>
3344 <li>
3345 <p>
3346 <em>keyonly[=&lt;bool&gt;]</em>: only show the key part of the trailer.
3347 </p>
3348 </li>
3349 <li>
3350 <p>
3351 <em>valueonly[=&lt;bool&gt;]</em>: only show the value part of the trailer.
3352 </p>
3353 </li>
3354 <li>
3355 <p>
3356 <em>key_value_separator=&lt;sep&gt;</em>: specify a separator inserted between
3357    trailer lines. When this option is not given each trailer key-value
3358    pair is separated by ": ". Otherwise it shares the same semantics
3359    as <em>separator=&lt;sep&gt;</em> above.
3360 </p>
3361 </li>
3362 </ul></div>
3363 </dd>
3364 </dl></div>
3365 </li>
3366 </ul></div>
3367 </li>
3368 </ul></div>
3369 <div class="admonitionblock">
3370 <table><tr>
3371 <td class="icon">
3372 <div class="title">Note</div>
3373 </td>
3374 <td class="content">Some placeholders may depend on other options given to the
3375 revision traversal engine. For example, the <code>%g*</code> reflog options will
3376 insert an empty string unless we are traversing reflog entries (e.g., by
3377 <code>git log -g</code>). The <code>%d</code> and <code>%D</code> placeholders will use the "short"
3378 decoration format if <code>--decorate</code> was not already provided on the command
3379 line.</td>
3380 </tr></table>
3381 </div>
3382 <div class="paragraph"><p>The boolean options accept an optional value <code>[=&lt;bool-value&gt;]</code>. The values
3383 <code>true</code>, <code>false</code>, <code>on</code>, <code>off</code> etc. are all accepted. See the "boolean"
3384 sub-section in "EXAMPLES" in <a href="git-config.html">git-config(1)</a>. If a boolean
3385 option is given with no value, it&#8217;s enabled.</p></div>
3386 <div class="paragraph"><p>If you add a <code>+</code> (plus sign) after <em>%</em> of a placeholder, a line-feed
3387 is inserted immediately before the expansion if and only if the
3388 placeholder expands to a non-empty string.</p></div>
3389 <div class="paragraph"><p>If you add a <code>-</code> (minus sign) after <em>%</em> of a placeholder, all consecutive
3390 line-feeds immediately preceding the expansion are deleted if and only if the
3391 placeholder expands to an empty string.</p></div>
3392 <div class="paragraph"><p>If you add a ` ` (space) after <em>%</em> of a placeholder, a space
3393 is inserted immediately before the expansion if and only if the
3394 placeholder expands to a non-empty string.</p></div>
3395 <div class="ulist"><ul>
3396 <li>
3397 <p>
3398 <em>tformat:</em>
3399 </p>
3400 <div class="paragraph"><p>The <em>tformat:</em> format works exactly like <em>format:</em>, except that it
3401 provides "terminator" semantics instead of "separator" semantics. In
3402 other words, each commit has the message terminator character (usually a
3403 newline) appended, rather than a separator placed between entries.
3404 This means that the final entry of a single-line format will be properly
3405 terminated with a new line, just as the "oneline" format does.
3406 For example:</p></div>
3407 <div class="listingblock">
3408 <div class="content">
3409 <pre><code>$ git log -2 --pretty=format:%h 4da45bef \
3410   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
3411 4da45be
3412 7134973 -- NO NEWLINE
3413
3414 $ git log -2 --pretty=tformat:%h 4da45bef \
3415   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
3416 4da45be
3417 7134973</code></pre>
3418 </div></div>
3419 <div class="paragraph"><p>In addition, any unrecognized string that has a <code>%</code> in it is interpreted
3420 as if it has <code>tformat:</code> in front of it.  For example, these two are
3421 equivalent:</p></div>
3422 <div class="listingblock">
3423 <div class="content">
3424 <pre><code>$ git log -2 --pretty=tformat:%h 4da45bef
3425 $ git log -2 --pretty=%h 4da45bef</code></pre>
3426 </div></div>
3427 </li>
3428 </ul></div>
3429 </div>
3430 </div>
3431 <div class="sect1">
3432 <h2 id="_raw_output_format">Raw output format</h2>
3433 <div class="sectionbody">
3434 <div class="paragraph"><p>The raw output format from "git-diff-index", "git-diff-tree",
3435 "git-diff-files" and "git diff --raw" are very similar.</p></div>
3436 <div class="paragraph"><p>These commands all compare two sets of things; what is
3437 compared differs:</p></div>
3438 <div class="dlist"><dl>
3439 <dt class="hdlist1">
3440 git-diff-index &lt;tree-ish&gt;
3441 </dt>
3442 <dd>
3443 <p>
3444         compares the &lt;tree-ish&gt; and the files on the filesystem.
3445 </p>
3446 </dd>
3447 <dt class="hdlist1">
3448 git-diff-index --cached &lt;tree-ish&gt;
3449 </dt>
3450 <dd>
3451 <p>
3452         compares the &lt;tree-ish&gt; and the index.
3453 </p>
3454 </dd>
3455 <dt class="hdlist1">
3456 git-diff-tree [-r] &lt;tree-ish-1&gt; &lt;tree-ish-2&gt; [&lt;pattern&gt;&#8230;]
3457 </dt>
3458 <dd>
3459 <p>
3460         compares the trees named by the two arguments.
3461 </p>
3462 </dd>
3463 <dt class="hdlist1">
3464 git-diff-files [&lt;pattern&gt;&#8230;]
3465 </dt>
3466 <dd>
3467 <p>
3468         compares the index and the files on the filesystem.
3469 </p>
3470 </dd>
3471 </dl></div>
3472 <div class="paragraph"><p>The "git-diff-tree" command begins its output by printing the hash of
3473 what is being compared. After that, all the commands print one output
3474 line per changed file.</p></div>
3475 <div class="paragraph"><p>An output line is formatted this way:</p></div>
3476 <div class="listingblock">
3477 <div class="content">
3478 <pre><code>in-place edit  :100644 100644 bcd1234 0123456 M file0
3479 copy-edit      :100644 100644 abcd123 1234567 C68 file1 file2
3480 rename-edit    :100644 100644 abcd123 1234567 R86 file1 file3
3481 create         :000000 100644 0000000 1234567 A file4
3482 delete         :100644 000000 1234567 0000000 D file5
3483 unmerged       :000000 000000 0000000 0000000 U file6</code></pre>
3484 </div></div>
3485 <div class="paragraph"><p>That is, from the left to the right:</p></div>
3486 <div class="olist arabic"><ol class="arabic">
3487 <li>
3488 <p>
3489 a colon.
3490 </p>
3491 </li>
3492 <li>
3493 <p>
3494 mode for "src"; 000000 if creation or unmerged.
3495 </p>
3496 </li>
3497 <li>
3498 <p>
3499 a space.
3500 </p>
3501 </li>
3502 <li>
3503 <p>
3504 mode for "dst"; 000000 if deletion or unmerged.
3505 </p>
3506 </li>
3507 <li>
3508 <p>
3509 a space.
3510 </p>
3511 </li>
3512 <li>
3513 <p>
3514 sha1 for "src"; 0{40} if creation or unmerged.
3515 </p>
3516 </li>
3517 <li>
3518 <p>
3519 a space.
3520 </p>
3521 </li>
3522 <li>
3523 <p>
3524 sha1 for "dst"; 0{40} if deletion, unmerged or "work tree out of sync with the index".
3525 </p>
3526 </li>
3527 <li>
3528 <p>
3529 a space.
3530 </p>
3531 </li>
3532 <li>
3533 <p>
3534 status, followed by optional "score" number.
3535 </p>
3536 </li>
3537 <li>
3538 <p>
3539 a tab or a NUL when <code>-z</code> option is used.
3540 </p>
3541 </li>
3542 <li>
3543 <p>
3544 path for "src"
3545 </p>
3546 </li>
3547 <li>
3548 <p>
3549 a tab or a NUL when <code>-z</code> option is used; only exists for C or R.
3550 </p>
3551 </li>
3552 <li>
3553 <p>
3554 path for "dst"; only exists for C or R.
3555 </p>
3556 </li>
3557 <li>
3558 <p>
3559 an LF or a NUL when <code>-z</code> option is used, to terminate the record.
3560 </p>
3561 </li>
3562 </ol></div>
3563 <div class="paragraph"><p>Possible status letters are:</p></div>
3564 <div class="ulist"><ul>
3565 <li>
3566 <p>
3567 A: addition of a file
3568 </p>
3569 </li>
3570 <li>
3571 <p>
3572 C: copy of a file into a new one
3573 </p>
3574 </li>
3575 <li>
3576 <p>
3577 D: deletion of a file
3578 </p>
3579 </li>
3580 <li>
3581 <p>
3582 M: modification of the contents or mode of a file
3583 </p>
3584 </li>
3585 <li>
3586 <p>
3587 R: renaming of a file
3588 </p>
3589 </li>
3590 <li>
3591 <p>
3592 T: change in the type of the file (regular file, symbolic link or submodule)
3593 </p>
3594 </li>
3595 <li>
3596 <p>
3597 U: file is unmerged (you must complete the merge before it can
3598   be committed)
3599 </p>
3600 </li>
3601 <li>
3602 <p>
3603 X: "unknown" change type (most probably a bug, please report it)
3604 </p>
3605 </li>
3606 </ul></div>
3607 <div class="paragraph"><p>Status letters C and R are always followed by a score (denoting the
3608 percentage of similarity between the source and target of the move or
3609 copy).  Status letter M may be followed by a score (denoting the
3610 percentage of dissimilarity) for file rewrites.</p></div>
3611 <div class="paragraph"><p>The sha1 for "dst" is shown as all 0&#8217;s if a file on the filesystem
3612 is out of sync with the index.</p></div>
3613 <div class="paragraph"><p>Example:</p></div>
3614 <div class="listingblock">
3615 <div class="content">
3616 <pre><code>:100644 100644 5be4a4a 0000000 M file.c</code></pre>
3617 </div></div>
3618 <div class="paragraph"><p>Without the <code>-z</code> option, pathnames with "unusual" characters are
3619 quoted as explained for the configuration variable <code>core.quotePath</code>
3620 (see <a href="git-config.html">git-config(1)</a>).  Using <code>-z</code> the filename is output
3621 verbatim and the line is terminated by a NUL byte.</p></div>
3622 </div>
3623 </div>
3624 <div class="sect1">
3625 <h2 id="_diff_format_for_merges">diff format for merges</h2>
3626 <div class="sectionbody">
3627 <div class="paragraph"><p>"git-diff-tree", "git-diff-files" and "git-diff --raw"
3628 can take <code>-c</code> or <code>--cc</code> option
3629 to generate diff output also for merge commits.  The output differs
3630 from the format described above in the following way:</p></div>
3631 <div class="olist arabic"><ol class="arabic">
3632 <li>
3633 <p>
3634 there is a colon for each parent
3635 </p>
3636 </li>
3637 <li>
3638 <p>
3639 there are more "src" modes and "src" sha1
3640 </p>
3641 </li>
3642 <li>
3643 <p>
3644 status is concatenated status characters for each parent
3645 </p>
3646 </li>
3647 <li>
3648 <p>
3649 no optional "score" number
3650 </p>
3651 </li>
3652 <li>
3653 <p>
3654 tab-separated pathname(s) of the file
3655 </p>
3656 </li>
3657 </ol></div>
3658 <div class="paragraph"><p>For <code>-c</code> and <code>--cc</code>, only the destination or final path is shown even
3659 if the file was renamed on any side of history.  With
3660 <code>--combined-all-paths</code>, the name of the path in each parent is shown
3661 followed by the name of the path in the merge commit.</p></div>
3662 <div class="paragraph"><p>Examples for <code>-c</code> and <code>--cc</code> without <code>--combined-all-paths</code>:</p></div>
3663 <div class="listingblock">
3664 <div class="content">
3665 <pre><code>::100644 100644 100644 fabadb8 cc95eb0 4866510 MM       desc.c
3666 ::100755 100755 100755 52b7a2d 6d1ac04 d2ac7d7 RM       bar.sh
3667 ::100644 100644 100644 e07d6c5 9042e82 ee91881 RR       phooey.c</code></pre>
3668 </div></div>
3669 <div class="paragraph"><p>Examples when <code>--combined-all-paths</code> added to either <code>-c</code> or <code>--cc</code>:</p></div>
3670 <div class="listingblock">
3671 <div class="content">
3672 <pre><code>::100644 100644 100644 fabadb8 cc95eb0 4866510 MM       desc.c  desc.c  desc.c
3673 ::100755 100755 100755 52b7a2d 6d1ac04 d2ac7d7 RM       foo.sh  bar.sh  bar.sh
3674 ::100644 100644 100644 e07d6c5 9042e82 ee91881 RR       fooey.c fuey.c  phooey.c</code></pre>
3675 </div></div>
3676 <div class="paragraph"><p>Note that <em>combined diff</em> lists only files which were modified from
3677 all parents.</p></div>
3678 </div>
3679 </div>
3680 <div class="sect1">
3681 <h2 id="generate_patch_text_with_p">Generating patch text with -p</h2>
3682 <div class="sectionbody">
3683 <div class="paragraph"><p>Running
3684 <a href="git-diff.html">git-diff(1)</a>,
3685 <a href="git-log.html">git-log(1)</a>,
3686 <a href="git-show.html">git-show(1)</a>,
3687 <a href="git-diff-index.html">git-diff-index(1)</a>,
3688 <a href="git-diff-tree.html">git-diff-tree(1)</a>, or
3689 <a href="git-diff-files.html">git-diff-files(1)</a>
3690 with the <code>-p</code> option produces patch text.
3691 You can customize the creation of patch text via the
3692 <code>GIT_EXTERNAL_DIFF</code> and the <code>GIT_DIFF_OPTS</code> environment variables
3693 (see <a href="git.html">git(1)</a>), and the <code>diff</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).</p></div>
3694 <div class="paragraph"><p>What the -p option produces is slightly different from the traditional
3695 diff format:</p></div>
3696 <div class="olist arabic"><ol class="arabic">
3697 <li>
3698 <p>
3699 It is preceded by a "git diff" header that looks like this:
3700 </p>
3701 <div class="literalblock">
3702 <div class="content">
3703 <pre><code>diff --git a/file1 b/file2</code></pre>
3704 </div></div>
3705 <div class="paragraph"><p>The <code>a/</code> and <code>b/</code> filenames are the same unless rename/copy is
3706 involved.  Especially, even for a creation or a deletion,
3707 <code>/dev/null</code> is <em>not</em> used in place of the <code>a/</code> or <code>b/</code> filenames.</p></div>
3708 <div class="paragraph"><p>When a rename/copy is involved, <code>file1</code> and <code>file2</code> show the
3709 name of the source file of the rename/copy and the name of
3710 the file that the rename/copy produces, respectively.</p></div>
3711 </li>
3712 <li>
3713 <p>
3714 It is followed by one or more extended header lines:
3715 </p>
3716 <div class="literalblock">
3717 <div class="content">
3718 <pre><code>old mode &lt;mode&gt;
3719 new mode &lt;mode&gt;
3720 deleted file mode &lt;mode&gt;
3721 new file mode &lt;mode&gt;
3722 copy from &lt;path&gt;
3723 copy to &lt;path&gt;
3724 rename from &lt;path&gt;
3725 rename to &lt;path&gt;
3726 similarity index &lt;number&gt;
3727 dissimilarity index &lt;number&gt;
3728 index &lt;hash&gt;..&lt;hash&gt; &lt;mode&gt;</code></pre>
3729 </div></div>
3730 <div class="paragraph"><p>File modes are printed as 6-digit octal numbers including the file type
3731 and file permission bits.</p></div>
3732 <div class="paragraph"><p>Path names in extended headers do not include the <code>a/</code> and <code>b/</code> prefixes.</p></div>
3733 <div class="paragraph"><p>The similarity index is the percentage of unchanged lines, and
3734 the dissimilarity index is the percentage of changed lines.  It
3735 is a rounded down integer, followed by a percent sign.  The
3736 similarity index value of 100% is thus reserved for two equal
3737 files, while 100% dissimilarity means that no line from the old
3738 file made it into the new one.</p></div>
3739 <div class="paragraph"><p>The index line includes the blob object names before and after the change.
3740 The &lt;mode&gt; is included if the file mode does not change; otherwise,
3741 separate lines indicate the old and the new mode.</p></div>
3742 </li>
3743 <li>
3744 <p>
3745 Pathnames with "unusual" characters are quoted as explained for
3746     the configuration variable <code>core.quotePath</code> (see
3747     <a href="git-config.html">git-config(1)</a>).
3748 </p>
3749 </li>
3750 <li>
3751 <p>
3752 All the <code>file1</code> files in the output refer to files before the
3753     commit, and all the <code>file2</code> files refer to files after the commit.
3754     It is incorrect to apply each change to each file sequentially.  For
3755     example, this patch will swap a and b:
3756 </p>
3757 <div class="literalblock">
3758 <div class="content">
3759 <pre><code>diff --git a/a b/b
3760 rename from a
3761 rename to b
3762 diff --git a/b b/a
3763 rename from b
3764 rename to a</code></pre>
3765 </div></div>
3766 </li>
3767 <li>
3768 <p>
3769 Hunk headers mention the name of the function to which the hunk
3770     applies.  See "Defining a custom hunk-header" in
3771     <a href="gitattributes.html">gitattributes(5)</a> for details of how to tailor this to
3772     specific languages.
3773 </p>
3774 </li>
3775 </ol></div>
3776 </div>
3777 </div>
3778 <div class="sect1">
3779 <h2 id="_combined_diff_format">Combined diff format</h2>
3780 <div class="sectionbody">
3781 <div class="paragraph"><p>Any diff-generating command can take the <code>-c</code> or <code>--cc</code> option to
3782 produce a <em>combined diff</em> when showing a merge. This is the default
3783 format when showing merges with <a href="git-diff.html">git-diff(1)</a> or
3784 <a href="git-show.html">git-show(1)</a>. Note also that you can give suitable
3785 <code>--diff-merges</code> option to any of these commands to force generation of
3786 diffs in a specific format.</p></div>
3787 <div class="paragraph"><p>A "combined diff" format looks like this:</p></div>
3788 <div class="listingblock">
3789 <div class="content">
3790 <pre><code>diff --combined describe.c
3791 index fabadb8,cc95eb0..4866510
3792 --- a/describe.c
3793 +++ b/describe.c
3794 @@@ -98,20 -98,12 +98,20 @@@
3795         return (a_date &gt; b_date) ? -1 : (a_date == b_date) ? 0 : 1;
3796   }
3797
3798 - static void describe(char *arg)
3799  -static void describe(struct commit *cmit, int last_one)
3800 ++static void describe(char *arg, int last_one)
3801   {
3802  +      unsigned char sha1[20];
3803  +      struct commit *cmit;
3804         struct commit_list *list;
3805         static int initialized = 0;
3806         struct commit_name *n;
3807
3808  +      if (get_sha1(arg, sha1) &lt; 0)
3809  +              usage(describe_usage);
3810  +      cmit = lookup_commit_reference(sha1);
3811  +      if (!cmit)
3812  +              usage(describe_usage);
3813  +
3814         if (!initialized) {
3815                 initialized = 1;
3816                 for_each_ref(get_name);</code></pre>
3817 </div></div>
3818 <div class="olist arabic"><ol class="arabic">
3819 <li>
3820 <p>
3821 It is preceded by a "git diff" header, that looks like
3822      this (when the <code>-c</code> option is used):
3823 </p>
3824 <div class="literalblock">
3825 <div class="content">
3826 <pre><code>diff --combined file</code></pre>
3827 </div></div>
3828 <div class="paragraph"><p>or like this (when the <code>--cc</code> option is used):</p></div>
3829 <div class="literalblock">
3830 <div class="content">
3831 <pre><code>diff --cc file</code></pre>
3832 </div></div>
3833 </li>
3834 <li>
3835 <p>
3836 It is followed by one or more extended header lines
3837      (this example shows a merge with two parents):
3838 </p>
3839 <div class="literalblock">
3840 <div class="content">
3841 <pre><code>index &lt;hash&gt;,&lt;hash&gt;..&lt;hash&gt;
3842 mode &lt;mode&gt;,&lt;mode&gt;..&lt;mode&gt;
3843 new file mode &lt;mode&gt;
3844 deleted file mode &lt;mode&gt;,&lt;mode&gt;</code></pre>
3845 </div></div>
3846 <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
3847 the &lt;mode&gt; is different from the rest. Extended headers with
3848 information about detected content movement (renames and
3849 copying detection) are designed to work with the diff of two
3850 &lt;tree-ish&gt; and are not used by combined diff format.</p></div>
3851 </li>
3852 <li>
3853 <p>
3854 It is followed by a two-line from-file/to-file header:
3855 </p>
3856 <div class="literalblock">
3857 <div class="content">
3858 <pre><code>--- a/file
3859 +++ b/file</code></pre>
3860 </div></div>
3861 <div class="paragraph"><p>Similar to the two-line header for the traditional <em>unified</em> diff
3862 format, <code>/dev/null</code> is used to signal created or deleted
3863 files.</p></div>
3864 <div class="paragraph"><p>However, if the --combined-all-paths option is provided, instead of a
3865 two-line from-file/to-file, you get an N+1 line from-file/to-file header,
3866 where N is the number of parents in the merge commit:</p></div>
3867 <div class="literalblock">
3868 <div class="content">
3869 <pre><code>--- a/file
3870 --- a/file
3871 --- a/file
3872 +++ b/file</code></pre>
3873 </div></div>
3874 <div class="paragraph"><p>This extended format can be useful if rename or copy detection is
3875 active, to allow you to see the original name of the file in different
3876 parents.</p></div>
3877 </li>
3878 <li>
3879 <p>
3880 Chunk header format is modified to prevent people from
3881      accidentally feeding it to <code>patch -p1</code>. Combined diff format
3882      was created for review of merge commit changes, and was not
3883      meant to be applied. The change is similar to the change in the
3884      extended <em>index</em> header:
3885 </p>
3886 <div class="literalblock">
3887 <div class="content">
3888 <pre><code>@@@ &lt;from-file-range&gt; &lt;from-file-range&gt; &lt;to-file-range&gt; @@@</code></pre>
3889 </div></div>
3890 <div class="paragraph"><p>There are (number of parents + 1) <code>@</code> characters in the chunk
3891 header for combined diff format.</p></div>
3892 </li>
3893 </ol></div>
3894 <div class="paragraph"><p>Unlike the traditional <em>unified</em> diff format, which shows two
3895 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
3896 added to B), or <code>" "</code> (space&#8201;&#8212;&#8201;unchanged) prefix, this format
3897 compares two or more files file1, file2,&#8230; with one file X, and
3898 shows how X differs from each of fileN.  One column for each of
3899 fileN is prepended to the output line to note how X&#8217;s line is
3900 different from it.</p></div>
3901 <div class="paragraph"><p>A <code>-</code> character in the column N means that the line appears in
3902 fileN but it does not appear in the result.  A <code>+</code> character
3903 in the column N means that the line appears in the result,
3904 and fileN does not have that line (in other words, the line was
3905 added, from the point of view of that parent).</p></div>
3906 <div class="paragraph"><p>In the above example output, the function signature was changed
3907 from both files (hence two <code>-</code> removals from both file1 and
3908 file2, plus <code>++</code> to mean one line that was added does not appear
3909 in either file1 or file2).  Also, eight other lines are the same
3910 from file1 but do not appear in file2 (hence prefixed with <code>+</code>).</p></div>
3911 <div class="paragraph"><p>When shown by <code>git diff-tree -c</code>, it compares the parents of a
3912 merge commit with the merge result (i.e. file1..fileN are the
3913 parents).  When shown by <code>git diff-files -c</code>, it compares the
3914 two unresolved merge parents with the working tree file
3915 (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka
3916 "their version").</p></div>
3917 </div>
3918 </div>
3919 <div class="sect1">
3920 <h2 id="_other_diff_formats">other diff formats</h2>
3921 <div class="sectionbody">
3922 <div class="paragraph"><p>The <code>--summary</code> option describes newly added, deleted, renamed and
3923 copied files.  The <code>--stat</code> option adds diffstat(1) graph to the
3924 output.  These options can be combined with other options, such as
3925 <code>-p</code>, and are meant for human consumption.</p></div>
3926 <div class="paragraph"><p>When showing a change that involves a rename or a copy, <code>--stat</code> output
3927 formats the pathnames compactly by combining common prefix and suffix of
3928 the pathnames.  For example, a change that moves <code>arch/i386/Makefile</code> to
3929 <code>arch/x86/Makefile</code> while modifying 4 lines will be shown like this:</p></div>
3930 <div class="listingblock">
3931 <div class="content">
3932 <pre><code>arch/{i386 =&gt; x86}/Makefile    |   4 +--</code></pre>
3933 </div></div>
3934 <div class="paragraph"><p>The <code>--numstat</code> option gives the diffstat(1) information but is designed
3935 for easier machine consumption.  An entry in <code>--numstat</code> output looks
3936 like this:</p></div>
3937 <div class="listingblock">
3938 <div class="content">
3939 <pre><code>1       2       README
3940 3       1       arch/{i386 =&gt; x86}/Makefile</code></pre>
3941 </div></div>
3942 <div class="paragraph"><p>That is, from left to right:</p></div>
3943 <div class="olist arabic"><ol class="arabic">
3944 <li>
3945 <p>
3946 the number of added lines;
3947 </p>
3948 </li>
3949 <li>
3950 <p>
3951 a tab;
3952 </p>
3953 </li>
3954 <li>
3955 <p>
3956 the number of deleted lines;
3957 </p>
3958 </li>
3959 <li>
3960 <p>
3961 a tab;
3962 </p>
3963 </li>
3964 <li>
3965 <p>
3966 pathname (possibly with rename/copy information);
3967 </p>
3968 </li>
3969 <li>
3970 <p>
3971 a newline.
3972 </p>
3973 </li>
3974 </ol></div>
3975 <div class="paragraph"><p>When <code>-z</code> output option is in effect, the output is formatted this way:</p></div>
3976 <div class="listingblock">
3977 <div class="content">
3978 <pre><code>1       2       README NUL
3979 3       1       NUL arch/i386/Makefile NUL arch/x86/Makefile NUL</code></pre>
3980 </div></div>
3981 <div class="paragraph"><p>That is:</p></div>
3982 <div class="olist arabic"><ol class="arabic">
3983 <li>
3984 <p>
3985 the number of added lines;
3986 </p>
3987 </li>
3988 <li>
3989 <p>
3990 a tab;
3991 </p>
3992 </li>
3993 <li>
3994 <p>
3995 the number of deleted lines;
3996 </p>
3997 </li>
3998 <li>
3999 <p>
4000 a tab;
4001 </p>
4002 </li>
4003 <li>
4004 <p>
4005 a NUL (only exists if renamed/copied);
4006 </p>
4007 </li>
4008 <li>
4009 <p>
4010 pathname in preimage;
4011 </p>
4012 </li>
4013 <li>
4014 <p>
4015 a NUL (only exists if renamed/copied);
4016 </p>
4017 </li>
4018 <li>
4019 <p>
4020 pathname in postimage (only exists if renamed/copied);
4021 </p>
4022 </li>
4023 <li>
4024 <p>
4025 a NUL.
4026 </p>
4027 </li>
4028 </ol></div>
4029 <div class="paragraph"><p>The extra <code>NUL</code> before the preimage path in renamed case is to allow
4030 scripts that read the output to tell if the current record being read is
4031 a single-path record or a rename/copy record without reading ahead.
4032 After reading added and deleted lines, reading up to <code>NUL</code> would yield
4033 the pathname, but if that is <code>NUL</code>, the record will show two paths.</p></div>
4034 </div>
4035 </div>
4036 <div class="sect1">
4037 <h2 id="_git">GIT</h2>
4038 <div class="sectionbody">
4039 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
4040 </div>
4041 </div>
4042 </div>
4043 <div id="footnotes"><hr /></div>
4044 <div id="footer">
4045 <div id="footer-text">
4046 Last updated
4047  2023-10-23 14:43:46 PDT
4048 </div>
4049 </div>
4050 </body>
4051 </html>