gitattributes.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>gitattributes(5)</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 gitattributes(5) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>gitattributes -
 743    Defining attributes per path
 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="paragraph"><p>$GIT_DIR/info/attributes, .gitattributes</p></div>
 752 </div>
 753 </div>
 754 <div class="sect1">
 755 <h2 id="_description">DESCRIPTION</h2>
 756 <div class="sectionbody">
 757 <div class="paragraph"><p>A <code>gitattributes</code> file is a simple text file that gives
 758 <code>attributes</code> to pathnames.</p></div>
 759 <div class="paragraph"><p>Each line in <code>gitattributes</code> file is of form:</p></div>
 760 <div class="literalblock">
 761 <div class="content">
 762 <pre><code>pattern attr1 attr2 ...</code></pre>
 763 </div></div>
 764 <div class="paragraph"><p>That is, a pattern followed by an attributes list,
 765 separated by whitespaces. Leading and trailing whitespaces are
 766 ignored. Lines that begin with <em>#</em> are ignored. Patterns
 767 that begin with a double quote are quoted in C style.
 768 When the pattern matches the path in question, the attributes
 769 listed on the line are given to the path.</p></div>
 770 <div class="paragraph"><p>Each attribute can be in one of these states for a given path:</p></div>
 771 <div class="dlist"><dl>
 772 <dt class="hdlist1">
 773 Set
 774 </dt>
 775 <dd>
 776 <p>
 777         The path has the attribute with special value "true";
 778         this is specified by listing only the name of the
 779         attribute in the attribute list.
 780 </p>
 781 </dd>
 782 <dt class="hdlist1">
 783 Unset
 784 </dt>
 785 <dd>
 786 <p>
 787         The path has the attribute with special value "false";
 788         this is specified by listing the name of the attribute
 789         prefixed with a dash <code>-</code> in the attribute list.
 790 </p>
 791 </dd>
 792 <dt class="hdlist1">
 793 Set to a value
 794 </dt>
 795 <dd>
 796 <p>
 797         The path has the attribute with specified string value;
 798         this is specified by listing the name of the attribute
 799         followed by an equal sign <code>=</code> and its value in the
 800         attribute list.
 801 </p>
 802 </dd>
 803 <dt class="hdlist1">
 804 Unspecified
 805 </dt>
 806 <dd>
 807 <p>
 808         No pattern matches the path, and nothing says if
 809         the path has or does not have the attribute, the
 810         attribute for the path is said to be Unspecified.
 811 </p>
 812 </dd>
 813 </dl></div>
 814 <div class="paragraph"><p>When more than one pattern matches the path, a later line
 815 overrides an earlier line.  This overriding is done per
 816 attribute.</p></div>
 817 <div class="paragraph"><p>The rules by which the pattern matches paths are the same as in
 818 <code>.gitignore</code> files (see <a href="gitignore.html">gitignore(5)</a>), with a few exceptions:</p></div>
 819 <div class="ulist"><ul>
 820 <li>
 821 <p>
 822 negative patterns are forbidden
 823 </p>
 824 </li>
 825 <li>
 826 <p>
 827 patterns that match a directory do not recursively match paths
 828     inside that directory (so using the trailing-slash <code>path/</code> syntax is
 829     pointless in an attributes file; use <code>path/**</code> instead)
 830 </p>
 831 </li>
 832 </ul></div>
 833 <div class="paragraph"><p>When deciding what attributes are assigned to a path, Git
 834 consults <code>$GIT_DIR/info/attributes</code> file (which has the highest
 835 precedence), <code>.gitattributes</code> file in the same directory as the
 836 path in question, and its parent directories up to the toplevel of the
 837 work tree (the further the directory that contains <code>.gitattributes</code>
 838 is from the path in question, the lower its precedence). Finally
 839 global and system-wide files are considered (they have the lowest
 840 precedence).</p></div>
 841 <div class="paragraph"><p>When the <code>.gitattributes</code> file is missing from the work tree, the
 842 path in the index is used as a fall-back.  During checkout process,
 843 <code>.gitattributes</code> in the index is used and then the file in the
 844 working tree is used as a fall-back.</p></div>
 845 <div class="paragraph"><p>If you wish to affect only a single repository (i.e., to assign
 846 attributes to files that are particular to
 847 one user&#8217;s workflow for that repository), then
 848 attributes should be placed in the <code>$GIT_DIR/info/attributes</code> file.
 849 Attributes which should be version-controlled and distributed to other
 850 repositories (i.e., attributes of interest to all users) should go into
 851 <code>.gitattributes</code> files. Attributes that should affect all repositories
 852 for a single user should be placed in a file specified by the
 853 <code>core.attributesFile</code> configuration option (see <a href="git-config.html">git-config(1)</a>).
 854 Its default value is $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME
 855 is either not set or empty, $HOME/.config/git/attributes is used instead.
 856 Attributes for all users on a system should be placed in the
 857 <code>$(prefix)/etc/gitattributes</code> file.</p></div>
 858 <div class="paragraph"><p>Sometimes you would need to override a setting of an attribute
 859 for a path to <code>Unspecified</code> state.  This can be done by listing
 860 the name of the attribute prefixed with an exclamation point <code>!</code>.</p></div>
 861 </div>
 862 </div>
 863 <div class="sect1">
 864 <h2 id="_effects">EFFECTS</h2>
 865 <div class="sectionbody">
 866 <div class="paragraph"><p>Certain operations by Git can be influenced by assigning
 867 particular attributes to a path.  Currently, the following
 868 operations are attributes-aware.</p></div>
 869 <div class="sect2">
 870 <h3 id="_checking_out_and_checking_in">Checking-out and checking-in</h3>
 871 <div class="paragraph"><p>These attributes affect how the contents stored in the
 872 repository are copied to the working tree files when commands
 873 such as <em>git switch</em>, <em>git checkout</em>  and <em>git merge</em> run.
 874 They also affect how
 875 Git stores the contents you prepare in the working tree in the
 876 repository upon <em>git add</em> and <em>git commit</em>.</p></div>
 877 <div class="sect3">
 878 <h4 id="_code_text_code"><code>text</code></h4>
 879 <div class="paragraph"><p>This attribute enables and controls end-of-line normalization.  When a
 880 text file is normalized, its line endings are converted to LF in the
 881 repository.  To control what line ending style is used in the working
 882 directory, use the <code>eol</code> attribute for a single file and the
 883 <code>core.eol</code> configuration variable for all text files.
 884 Note that setting <code>core.autocrlf</code> to <code>true</code> or <code>input</code> overrides
 885 <code>core.eol</code> (see the definitions of those options in
 886 <a href="git-config.html">git-config(1)</a>).</p></div>
 887 <div class="dlist"><dl>
 888 <dt class="hdlist1">
 889 Set
 890 </dt>
 891 <dd>
 892 <p>
 893         Setting the <code>text</code> attribute on a path enables end-of-line
 894         normalization and marks the path as a text file.  End-of-line
 895         conversion takes place without guessing the content type.
 896 </p>
 897 </dd>
 898 <dt class="hdlist1">
 899 Unset
 900 </dt>
 901 <dd>
 902 <p>
 903         Unsetting the <code>text</code> attribute on a path tells Git not to
 904         attempt any end-of-line conversion upon checkin or checkout.
 905 </p>
 906 </dd>
 907 <dt class="hdlist1">
 908 Set to string value "auto"
 909 </dt>
 910 <dd>
 911 <p>
 912         When <code>text</code> is set to "auto", the path is marked for automatic
 913         end-of-line conversion.  If Git decides that the content is
 914         text, its line endings are converted to LF on checkin.
 915         When the file has been committed with CRLF, no conversion is done.
 916 </p>
 917 </dd>
 918 <dt class="hdlist1">
 919 Unspecified
 920 </dt>
 921 <dd>
 922 <p>
 923         If the <code>text</code> attribute is unspecified, Git uses the
 924         <code>core.autocrlf</code> configuration variable to determine if the
 925         file should be converted.
 926 </p>
 927 </dd>
 928 </dl></div>
 929 <div class="paragraph"><p>Any other value causes Git to act as if <code>text</code> has been left
 930 unspecified.</p></div>
 931 </div>
 932 <div class="sect3">
 933 <h4 id="_code_eol_code"><code>eol</code></h4>
 934 <div class="paragraph"><p>This attribute sets a specific line-ending style to be used in the
 935 working directory.  This attribute has effect only if the <code>text</code>
 936 attribute is set or unspecified, or if it is set to <code>auto</code>, the file is
 937 detected as text, and it is stored with LF endings in the index.  Note
 938 that setting this attribute on paths which are in the index with CRLF
 939 line endings may make the paths to be considered dirty unless
 940 <code>text=auto</code> is set. Adding the path to the index again will normalize
 941 the line endings in the index.</p></div>
 942 <div class="dlist"><dl>
 943 <dt class="hdlist1">
 944 Set to string value "crlf"
 945 </dt>
 946 <dd>
 947 <p>
 948         This setting forces Git to normalize line endings for this
 949         file on checkin and convert them to CRLF when the file is
 950         checked out.
 951 </p>
 952 </dd>
 953 <dt class="hdlist1">
 954 Set to string value "lf"
 955 </dt>
 956 <dd>
 957 <p>
 958         This setting forces Git to normalize line endings to LF on
 959         checkin and prevents conversion to CRLF when the file is
 960         checked out.
 961 </p>
 962 </dd>
 963 </dl></div>
 964 </div>
 965 <div class="sect3">
 966 <h4 id="_backwards_compatibility_with_code_crlf_code_attribute">Backwards compatibility with <code>crlf</code> attribute</h4>
 967 <div class="paragraph"><p>For backwards compatibility, the <code>crlf</code> attribute is interpreted as
 968 follows:</p></div>
 969 <div class="listingblock">
 970 <div class="content">
 971 <pre><code>crlf            text
 972 -crlf           -text
 973 crlf=input      eol=lf</code></pre>
 974 </div></div>
 975 </div>
 976 <div class="sect3">
 977 <h4 id="_end_of_line_conversion">End-of-line conversion</h4>
 978 <div class="paragraph"><p>While Git normally leaves file contents alone, it can be configured to
 979 normalize line endings to LF in the repository and, optionally, to
 980 convert them to CRLF when files are checked out.</p></div>
 981 <div class="paragraph"><p>If you simply want to have CRLF line endings in your working directory
 982 regardless of the repository you are working with, you can set the
 983 config variable "core.autocrlf" without using any attributes.</p></div>
 984 <div class="listingblock">
 985 <div class="content">
 986 <pre><code>[core]
 987         autocrlf = true</code></pre>
 988 </div></div>
 989 <div class="paragraph"><p>This does not force normalization of text files, but does ensure
 990 that text files that you introduce to the repository have their line
 991 endings normalized to LF when they are added, and that files that are
 992 already normalized in the repository stay normalized.</p></div>
 993 <div class="paragraph"><p>If you want to ensure that text files that any contributor introduces to
 994 the repository have their line endings normalized, you can set the
 995 <code>text</code> attribute to "auto" for <em>all</em> files.</p></div>
 996 <div class="listingblock">
 997 <div class="content">
 998 <pre><code>*       text=auto</code></pre>
 999 </div></div>
1000 <div class="paragraph"><p>The attributes allow a fine-grained control, how the line endings
1001 are converted.
1002 Here is an example that will make Git normalize .txt, .vcproj and .sh
1003 files, ensure that .vcproj files have CRLF and .sh files have LF in
1004 the working directory, and prevent .jpg files from being normalized
1005 regardless of their content.</p></div>
1006 <div class="listingblock">
1007 <div class="content">
1008 <pre><code>*               text=auto
1009 *.txt           text
1010 *.vcproj        text eol=crlf
1011 *.sh            text eol=lf
1012 *.jpg           -text</code></pre>
1013 </div></div>
1014 <div class="admonitionblock">
1015 <table><tr>
1016 <td class="icon">
1017 <div class="title">Note</div>
1018 </td>
1019 <td class="content">When <code>text=auto</code> conversion is enabled in a cross-platform
1020 project using push and pull to a central repository the text files
1021 containing CRLFs should be normalized.</td>
1022 </tr></table>
1023 </div>
1024 <div class="paragraph"><p>From a clean working directory:</p></div>
1025 <div class="listingblock">
1026 <div class="content">
1027 <pre><code>$ echo "* text=auto" &gt;.gitattributes
1028 $ git add --renormalize .
1029 $ git status        # Show files that will be normalized
1030 $ git commit -m "Introduce end-of-line normalization"</code></pre>
1031 </div></div>
1032 <div class="paragraph"><p>If any files that should not be normalized show up in <em>git status</em>,
1033 unset their <code>text</code> attribute before running <em>git add -u</em>.</p></div>
1034 <div class="listingblock">
1035 <div class="content">
1036 <pre><code>manual.pdf      -text</code></pre>
1037 </div></div>
1038 <div class="paragraph"><p>Conversely, text files that Git does not detect can have normalization
1039 enabled manually.</p></div>
1040 <div class="listingblock">
1041 <div class="content">
1042 <pre><code>weirdchars.txt  text</code></pre>
1043 </div></div>
1044 <div class="paragraph"><p>If <code>core.safecrlf</code> is set to "true" or "warn", Git verifies if
1045 the conversion is reversible for the current setting of
1046 <code>core.autocrlf</code>.  For "true", Git rejects irreversible
1047 conversions; for "warn", Git only prints a warning but accepts
1048 an irreversible conversion.  The safety triggers to prevent such
1049 a conversion done to the files in the work tree, but there are a
1050 few exceptions.  Even though&#8230;</p></div>
1051 <div class="ulist"><ul>
1052 <li>
1053 <p>
1054 <em>git add</em> itself does not touch the files in the work tree, the
1055   next checkout would, so the safety triggers;
1056 </p>
1057 </li>
1058 <li>
1059 <p>
1060 <em>git apply</em> to update a text file with a patch does touch the files
1061   in the work tree, but the operation is about text files and CRLF
1062   conversion is about fixing the line ending inconsistencies, so the
1063   safety does not trigger;
1064 </p>
1065 </li>
1066 <li>
1067 <p>
1068 <em>git diff</em> itself does not touch the files in the work tree, it is
1069   often run to inspect the changes you intend to next <em>git add</em>.  To
1070   catch potential problems early, safety triggers.
1071 </p>
1072 </li>
1073 </ul></div>
1074 </div>
1075 <div class="sect3">
1076 <h4 id="_code_working_tree_encoding_code"><code>working-tree-encoding</code></h4>
1077 <div class="paragraph"><p>Git recognizes files encoded in ASCII or one of its supersets (e.g.
1078 UTF-8, ISO-8859-1, &#8230;) as text files. Files encoded in certain other
1079 encodings (e.g. UTF-16) are interpreted as binary and consequently
1080 built-in Git text processing tools (e.g. <em>git diff</em>) as well as most Git
1081 web front ends do not visualize the contents of these files by default.</p></div>
1082 <div class="paragraph"><p>In these cases you can tell Git the encoding of a file in the working
1083 directory with the <code>working-tree-encoding</code> attribute. If a file with this
1084 attribute is added to Git, then Git re-encodes the content from the
1085 specified encoding to UTF-8. Finally, Git stores the UTF-8 encoded
1086 content in its internal data structure (called "the index"). On checkout
1087 the content is re-encoded back to the specified encoding.</p></div>
1088 <div class="paragraph"><p>Please note that using the <code>working-tree-encoding</code> attribute may have a
1089 number of pitfalls:</p></div>
1090 <div class="ulist"><ul>
1091 <li>
1092 <p>
1093 Alternative Git implementations (e.g. JGit or libgit2) and older Git
1094   versions (as of March 2018) do not support the <code>working-tree-encoding</code>
1095   attribute. If you decide to use the <code>working-tree-encoding</code> attribute
1096   in your repository, then it is strongly recommended to ensure that all
1097   clients working with the repository support it.
1098 </p>
1099 <div class="paragraph"><p>For example, Microsoft Visual Studio resources files (<code>*.rc</code>) or
1100 PowerShell script files (<code>*.ps1</code>) are sometimes encoded in UTF-16.
1101 If you declare <code>*.ps1</code> as files as UTF-16 and you add <code>foo.ps1</code> with
1102 a <code>working-tree-encoding</code> enabled Git client, then <code>foo.ps1</code> will be
1103 stored as UTF-8 internally. A client without <code>working-tree-encoding</code>
1104 support will checkout <code>foo.ps1</code> as UTF-8 encoded file. This will
1105 typically cause trouble for the users of this file.</p></div>
1106 <div class="paragraph"><p>If a Git client that does not support the <code>working-tree-encoding</code>
1107 attribute adds a new file <code>bar.ps1</code>, then <code>bar.ps1</code> will be
1108 stored "as-is" internally (in this example probably as UTF-16).
1109 A client with <code>working-tree-encoding</code> support will interpret the
1110 internal contents as UTF-8 and try to convert it to UTF-16 on checkout.
1111 That operation will fail and cause an error.</p></div>
1112 </li>
1113 <li>
1114 <p>
1115 Reencoding content to non-UTF encodings can cause errors as the
1116   conversion might not be UTF-8 round trip safe. If you suspect your
1117   encoding to not be round trip safe, then add it to
1118   <code>core.checkRoundtripEncoding</code> to make Git check the round trip
1119   encoding (see <a href="git-config.html">git-config(1)</a>). SHIFT-JIS (Japanese character
1120   set) is known to have round trip issues with UTF-8 and is checked by
1121   default.
1122 </p>
1123 </li>
1124 <li>
1125 <p>
1126 Reencoding content requires resources that might slow down certain
1127   Git operations (e.g <em>git checkout</em> or <em>git add</em>).
1128 </p>
1129 </li>
1130 </ul></div>
1131 <div class="paragraph"><p>Use the <code>working-tree-encoding</code> attribute only if you cannot store a file
1132 in UTF-8 encoding and if you want Git to be able to process the content
1133 as text.</p></div>
1134 <div class="paragraph"><p>As an example, use the following attributes if your <em>*.ps1</em> files are
1135 UTF-16 encoded with byte order mark (BOM) and you want Git to perform
1136 automatic line ending conversion based on your platform.</p></div>
1137 <div class="listingblock">
1138 <div class="content">
1139 <pre><code>*.ps1           text working-tree-encoding=UTF-16</code></pre>
1140 </div></div>
1141 <div class="paragraph"><p>Use the following attributes if your <em>*.ps1</em> files are UTF-16 little
1142 endian encoded without BOM and you want Git to use Windows line endings
1143 in the working directory (use <code>UTF-16LE-BOM</code> instead of <code>UTF-16LE</code> if
1144 you want UTF-16 little endian with BOM).
1145 Please note, it is highly recommended to
1146 explicitly define the line endings with <code>eol</code> if the <code>working-tree-encoding</code>
1147 attribute is used to avoid ambiguity.</p></div>
1148 <div class="listingblock">
1149 <div class="content">
1150 <pre><code>*.ps1           text working-tree-encoding=UTF-16LE eol=CRLF</code></pre>
1151 </div></div>
1152 <div class="paragraph"><p>You can get a list of all available encodings on your platform with the
1153 following command:</p></div>
1154 <div class="listingblock">
1155 <div class="content">
1156 <pre><code>iconv --list</code></pre>
1157 </div></div>
1158 <div class="paragraph"><p>If you do not know the encoding of a file, then you can use the <code>file</code>
1159 command to guess the encoding:</p></div>
1160 <div class="listingblock">
1161 <div class="content">
1162 <pre><code>file foo.ps1</code></pre>
1163 </div></div>
1164 </div>
1165 <div class="sect3">
1166 <h4 id="_code_ident_code"><code>ident</code></h4>
1167 <div class="paragraph"><p>When the attribute <code>ident</code> is set for a path, Git replaces
1168 <code>$Id$</code> in the blob object with <code>$Id:</code>, followed by the
1169 40-character hexadecimal blob object name, followed by a dollar
1170 sign <code>$</code> upon checkout.  Any byte sequence that begins with
1171 <code>$Id:</code> and ends with <code>$</code> in the worktree file is replaced
1172 with <code>$Id$</code> upon check-in.</p></div>
1173 </div>
1174 <div class="sect3">
1175 <h4 id="_code_filter_code"><code>filter</code></h4>
1176 <div class="paragraph"><p>A <code>filter</code> attribute can be set to a string value that names a
1177 filter driver specified in the configuration.</p></div>
1178 <div class="paragraph"><p>A filter driver consists of a <code>clean</code> command and a <code>smudge</code>
1179 command, either of which can be left unspecified.  Upon
1180 checkout, when the <code>smudge</code> command is specified, the command is
1181 fed the blob object from its standard input, and its standard
1182 output is used to update the worktree file.  Similarly, the
1183 <code>clean</code> command is used to convert the contents of worktree file
1184 upon checkin. By default these commands process only a single
1185 blob and terminate. If a long running <code>process</code> filter is used
1186 in place of <code>clean</code> and/or <code>smudge</code> filters, then Git can process
1187 all blobs with a single filter command invocation for the entire
1188 life of a single Git command, for example <code>git add --all</code>. If a
1189 long running <code>process</code> filter is configured then it always takes
1190 precedence over a configured single blob filter. See section
1191 below for the description of the protocol used to communicate with
1192 a <code>process</code> filter.</p></div>
1193 <div class="paragraph"><p>One use of the content filtering is to massage the content into a shape
1194 that is more convenient for the platform, filesystem, and the user to use.
1195 For this mode of operation, the key phrase here is "more convenient" and
1196 not "turning something unusable into usable".  In other words, the intent
1197 is that if someone unsets the filter driver definition, or does not have
1198 the appropriate filter program, the project should still be usable.</p></div>
1199 <div class="paragraph"><p>Another use of the content filtering is to store the content that cannot
1200 be directly used in the repository (e.g. a UUID that refers to the true
1201 content stored outside Git, or an encrypted content) and turn it into a
1202 usable form upon checkout (e.g. download the external content, or decrypt
1203 the encrypted content).</p></div>
1204 <div class="paragraph"><p>These two filters behave differently, and by default, a filter is taken as
1205 the former, massaging the contents into more convenient shape.  A missing
1206 filter driver definition in the config, or a filter driver that exits with
1207 a non-zero status, is not an error but makes the filter a no-op passthru.</p></div>
1208 <div class="paragraph"><p>You can declare that a filter turns a content that by itself is unusable
1209 into a usable content by setting the filter.&lt;driver&gt;.required configuration
1210 variable to <code>true</code>.</p></div>
1211 <div class="paragraph"><p>Note: Whenever the clean filter is changed, the repo should be renormalized:
1212 $ git add --renormalize .</p></div>
1213 <div class="paragraph"><p>For example, in .gitattributes, you would assign the <code>filter</code>
1214 attribute for paths.</p></div>
1215 <div class="listingblock">
1216 <div class="content">
1217 <pre><code>*.c     filter=indent</code></pre>
1218 </div></div>
1219 <div class="paragraph"><p>Then you would define a "filter.indent.clean" and "filter.indent.smudge"
1220 configuration in your .git/config to specify a pair of commands to
1221 modify the contents of C programs when the source files are checked
1222 in ("clean" is run) and checked out (no change is made because the
1223 command is "cat").</p></div>
1224 <div class="listingblock">
1225 <div class="content">
1226 <pre><code>[filter "indent"]
1227         clean = indent
1228         smudge = cat</code></pre>
1229 </div></div>
1230 <div class="paragraph"><p>For best results, <code>clean</code> should not alter its output further if it is
1231 run twice ("clean&#8594;clean" should be equivalent to "clean"), and
1232 multiple <code>smudge</code> commands should not alter <code>clean</code>'s output
1233 ("smudge&#8594;smudge&#8594;clean" should be equivalent to "clean").  See the
1234 section on merging below.</p></div>
1235 <div class="paragraph"><p>The "indent" filter is well-behaved in this regard: it will not modify
1236 input that is already correctly indented.  In this case, the lack of a
1237 smudge filter means that the clean filter <em>must</em> accept its own output
1238 without modifying it.</p></div>
1239 <div class="paragraph"><p>If a filter <em>must</em> succeed in order to make the stored contents usable,
1240 you can declare that the filter is <code>required</code>, in the configuration:</p></div>
1241 <div class="listingblock">
1242 <div class="content">
1243 <pre><code>[filter "crypt"]
1244         clean = openssl enc ...
1245         smudge = openssl enc -d ...
1246         required</code></pre>
1247 </div></div>
1248 <div class="paragraph"><p>Sequence "%f" on the filter command line is replaced with the name of
1249 the file the filter is working on.  A filter might use this in keyword
1250 substitution.  For example:</p></div>
1251 <div class="listingblock">
1252 <div class="content">
1253 <pre><code>[filter "p4"]
1254         clean = git-p4-filter --clean %f
1255         smudge = git-p4-filter --smudge %f</code></pre>
1256 </div></div>
1257 <div class="paragraph"><p>Note that "%f" is the name of the path that is being worked on. Depending
1258 on the version that is being filtered, the corresponding file on disk may
1259 not exist, or may have different contents. So, smudge and clean commands
1260 should not try to access the file on disk, but only act as filters on the
1261 content provided to them on standard input.</p></div>
1262 </div>
1263 <div class="sect3">
1264 <h4 id="_long_running_filter_process">Long Running Filter Process</h4>
1265 <div class="paragraph"><p>If the filter command (a string value) is defined via
1266 <code>filter.&lt;driver&gt;.process</code> then Git can process all blobs with a
1267 single filter invocation for the entire life of a single Git
1268 command. This is achieved by using the long-running process protocol
1269 (described in technical/long-running-process-protocol.txt).</p></div>
1270 <div class="paragraph"><p>When Git encounters the first file that needs to be cleaned or smudged,
1271 it starts the filter and performs the handshake. In the handshake, the
1272 welcome message sent by Git is "git-filter-client", only version 2 is
1273 supported, and the supported capabilities are "clean", "smudge", and
1274 "delay".</p></div>
1275 <div class="paragraph"><p>Afterwards Git sends a list of "key=value" pairs terminated with
1276 a flush packet. The list will contain at least the filter command
1277 (based on the supported capabilities) and the pathname of the file
1278 to filter relative to the repository root. Right after the flush packet
1279 Git sends the content split in zero or more pkt-line packets and a
1280 flush packet to terminate content. Please note, that the filter
1281 must not send any response before it received the content and the
1282 final flush packet. Also note that the "value" of a "key=value" pair
1283 can contain the "=" character whereas the key would never contain
1284 that character.</p></div>
1285 <div class="listingblock">
1286 <div class="content">
1287 <pre><code>packet:          git&gt; command=smudge
1288 packet:          git&gt; pathname=path/testfile.dat
1289 packet:          git&gt; 0000
1290 packet:          git&gt; CONTENT
1291 packet:          git&gt; 0000</code></pre>
1292 </div></div>
1293 <div class="paragraph"><p>The filter is expected to respond with a list of "key=value" pairs
1294 terminated with a flush packet. If the filter does not experience
1295 problems then the list must contain a "success" status. Right after
1296 these packets the filter is expected to send the content in zero
1297 or more pkt-line packets and a flush packet at the end. Finally, a
1298 second list of "key=value" pairs terminated with a flush packet
1299 is expected. The filter can change the status in the second list
1300 or keep the status as is with an empty list. Please note that the
1301 empty list must be terminated with a flush packet regardless.</p></div>
1302 <div class="listingblock">
1303 <div class="content">
1304 <pre><code>packet:          git&lt; status=success
1305 packet:          git&lt; 0000
1306 packet:          git&lt; SMUDGED_CONTENT
1307 packet:          git&lt; 0000
1308 packet:          git&lt; 0000  # empty list, keep "status=success" unchanged!</code></pre>
1309 </div></div>
1310 <div class="paragraph"><p>If the result content is empty then the filter is expected to respond
1311 with a "success" status and a flush packet to signal the empty content.</p></div>
1312 <div class="listingblock">
1313 <div class="content">
1314 <pre><code>packet:          git&lt; status=success
1315 packet:          git&lt; 0000
1316 packet:          git&lt; 0000  # empty content!
1317 packet:          git&lt; 0000  # empty list, keep "status=success" unchanged!</code></pre>
1318 </div></div>
1319 <div class="paragraph"><p>In case the filter cannot or does not want to process the content,
1320 it is expected to respond with an "error" status.</p></div>
1321 <div class="listingblock">
1322 <div class="content">
1323 <pre><code>packet:          git&lt; status=error
1324 packet:          git&lt; 0000</code></pre>
1325 </div></div>
1326 <div class="paragraph"><p>If the filter experiences an error during processing, then it can
1327 send the status "error" after the content was (partially or
1328 completely) sent.</p></div>
1329 <div class="listingblock">
1330 <div class="content">
1331 <pre><code>packet:          git&lt; status=success
1332 packet:          git&lt; 0000
1333 packet:          git&lt; HALF_WRITTEN_ERRONEOUS_CONTENT
1334 packet:          git&lt; 0000
1335 packet:          git&lt; status=error
1336 packet:          git&lt; 0000</code></pre>
1337 </div></div>
1338 <div class="paragraph"><p>In case the filter cannot or does not want to process the content
1339 as well as any future content for the lifetime of the Git process,
1340 then it is expected to respond with an "abort" status at any point
1341 in the protocol.</p></div>
1342 <div class="listingblock">
1343 <div class="content">
1344 <pre><code>packet:          git&lt; status=abort
1345 packet:          git&lt; 0000</code></pre>
1346 </div></div>
1347 <div class="paragraph"><p>Git neither stops nor restarts the filter process in case the
1348 "error"/"abort" status is set. However, Git sets its exit code
1349 according to the <code>filter.&lt;driver&gt;.required</code> flag, mimicking the
1350 behavior of the <code>filter.&lt;driver&gt;.clean</code> / <code>filter.&lt;driver&gt;.smudge</code>
1351 mechanism.</p></div>
1352 <div class="paragraph"><p>If the filter dies during the communication or does not adhere to
1353 the protocol then Git will stop the filter process and restart it
1354 with the next file that needs to be processed. Depending on the
1355 <code>filter.&lt;driver&gt;.required</code> flag Git will interpret that as error.</p></div>
1356 </div>
1357 <div class="sect3">
1358 <h4 id="_delay">Delay</h4>
1359 <div class="paragraph"><p>If the filter supports the "delay" capability, then Git can send the
1360 flag "can-delay" after the filter command and pathname. This flag
1361 denotes that the filter can delay filtering the current blob (e.g. to
1362 compensate network latencies) by responding with no content but with
1363 the status "delayed" and a flush packet.</p></div>
1364 <div class="listingblock">
1365 <div class="content">
1366 <pre><code>packet:          git&gt; command=smudge
1367 packet:          git&gt; pathname=path/testfile.dat
1368 packet:          git&gt; can-delay=1
1369 packet:          git&gt; 0000
1370 packet:          git&gt; CONTENT
1371 packet:          git&gt; 0000
1372 packet:          git&lt; status=delayed
1373 packet:          git&lt; 0000</code></pre>
1374 </div></div>
1375 <div class="paragraph"><p>If the filter supports the "delay" capability then it must support the
1376 "list_available_blobs" command. If Git sends this command, then the
1377 filter is expected to return a list of pathnames representing blobs
1378 that have been delayed earlier and are now available.
1379 The list must be terminated with a flush packet followed
1380 by a "success" status that is also terminated with a flush packet. If
1381 no blobs for the delayed paths are available, yet, then the filter is
1382 expected to block the response until at least one blob becomes
1383 available. The filter can tell Git that it has no more delayed blobs
1384 by sending an empty list. As soon as the filter responds with an empty
1385 list, Git stops asking. All blobs that Git has not received at this
1386 point are considered missing and will result in an error.</p></div>
1387 <div class="listingblock">
1388 <div class="content">
1389 <pre><code>packet:          git&gt; command=list_available_blobs
1390 packet:          git&gt; 0000
1391 packet:          git&lt; pathname=path/testfile.dat
1392 packet:          git&lt; pathname=path/otherfile.dat
1393 packet:          git&lt; 0000
1394 packet:          git&lt; status=success
1395 packet:          git&lt; 0000</code></pre>
1396 </div></div>
1397 <div class="paragraph"><p>After Git received the pathnames, it will request the corresponding
1398 blobs again. These requests contain a pathname and an empty content
1399 section. The filter is expected to respond with the smudged content
1400 in the usual way as explained above.</p></div>
1401 <div class="listingblock">
1402 <div class="content">
1403 <pre><code>packet:          git&gt; command=smudge
1404 packet:          git&gt; pathname=path/testfile.dat
1405 packet:          git&gt; 0000
1406 packet:          git&gt; 0000  # empty content!
1407 packet:          git&lt; status=success
1408 packet:          git&lt; 0000
1409 packet:          git&lt; SMUDGED_CONTENT
1410 packet:          git&lt; 0000
1411 packet:          git&lt; 0000  # empty list, keep "status=success" unchanged!</code></pre>
1412 </div></div>
1413 </div>
1414 <div class="sect3">
1415 <h4 id="_example">Example</h4>
1416 <div class="paragraph"><p>A long running filter demo implementation can be found in
1417 <code>contrib/long-running-filter/example.pl</code> located in the Git
1418 core repository. If you develop your own long running filter
1419 process then the <code>GIT_TRACE_PACKET</code> environment variables can be
1420 very helpful for debugging (see <a href="git.html">git(1)</a>).</p></div>
1421 <div class="paragraph"><p>Please note that you cannot use an existing <code>filter.&lt;driver&gt;.clean</code>
1422 or <code>filter.&lt;driver&gt;.smudge</code> command with <code>filter.&lt;driver&gt;.process</code>
1423 because the former two use a different inter process communication
1424 protocol than the latter one.</p></div>
1425 </div>
1426 <div class="sect3">
1427 <h4 id="_interaction_between_checkin_checkout_attributes">Interaction between checkin/checkout attributes</h4>
1428 <div class="paragraph"><p>In the check-in codepath, the worktree file is first converted
1429 with <code>filter</code> driver (if specified and corresponding driver
1430 defined), then the result is processed with <code>ident</code> (if
1431 specified), and then finally with <code>text</code> (again, if specified
1432 and applicable).</p></div>
1433 <div class="paragraph"><p>In the check-out codepath, the blob content is first converted
1434 with <code>text</code>, and then <code>ident</code> and fed to <code>filter</code>.</p></div>
1435 </div>
1436 <div class="sect3">
1437 <h4 id="_merging_branches_with_differing_checkin_checkout_attributes">Merging branches with differing checkin/checkout attributes</h4>
1438 <div class="paragraph"><p>If you have added attributes to a file that cause the canonical
1439 repository format for that file to change, such as adding a
1440 clean/smudge filter or text/eol/ident attributes, merging anything
1441 where the attribute is not in place would normally cause merge
1442 conflicts.</p></div>
1443 <div class="paragraph"><p>To prevent these unnecessary merge conflicts, Git can be told to run a
1444 virtual check-out and check-in of all three stages of a file when
1445 resolving a three-way merge by setting the <code>merge.renormalize</code>
1446 configuration variable.  This prevents changes caused by check-in
1447 conversion from causing spurious merge conflicts when a converted file
1448 is merged with an unconverted file.</p></div>
1449 <div class="paragraph"><p>As long as a "smudge&#8594;clean" results in the same output as a "clean"
1450 even on files that are already smudged, this strategy will
1451 automatically resolve all filter-related conflicts.  Filters that do
1452 not act in this way may cause additional merge conflicts that must be
1453 resolved manually.</p></div>
1454 </div>
1455 </div>
1456 <div class="sect2">
1457 <h3 id="_generating_diff_text">Generating diff text</h3>
1458 <div class="sect3">
1459 <h4 id="_code_diff_code"><code>diff</code></h4>
1460 <div class="paragraph"><p>The attribute <code>diff</code> affects how Git generates diffs for particular
1461 files. It can tell Git whether to generate a textual patch for the path
1462 or to treat the path as a binary file.  It can also affect what line is
1463 shown on the hunk header <code>@@ -k,l +n,m @@</code> line, tell Git to use an
1464 external command to generate the diff, or ask Git to convert binary
1465 files to a text format before generating the diff.</p></div>
1466 <div class="dlist"><dl>
1467 <dt class="hdlist1">
1468 Set
1469 </dt>
1470 <dd>
1471 <p>
1472         A path to which the <code>diff</code> attribute is set is treated
1473         as text, even when they contain byte values that
1474         normally never appear in text files, such as NUL.
1475 </p>
1476 </dd>
1477 <dt class="hdlist1">
1478 Unset
1479 </dt>
1480 <dd>
1481 <p>
1482         A path to which the <code>diff</code> attribute is unset will
1483         generate <code>Binary files differ</code> (or a binary patch, if
1484         binary patches are enabled).
1485 </p>
1486 </dd>
1487 <dt class="hdlist1">
1488 Unspecified
1489 </dt>
1490 <dd>
1491 <p>
1492         A path to which the <code>diff</code> attribute is unspecified
1493         first gets its contents inspected, and if it looks like
1494         text and is smaller than core.bigFileThreshold, it is treated
1495         as text. Otherwise it would generate <code>Binary files differ</code>.
1496 </p>
1497 </dd>
1498 <dt class="hdlist1">
1499 String
1500 </dt>
1501 <dd>
1502 <p>
1503         Diff is shown using the specified diff driver.  Each driver may
1504         specify one or more options, as described in the following
1505         section. The options for the diff driver "foo" are defined
1506         by the configuration variables in the "diff.foo" section of the
1507         Git config file.
1508 </p>
1509 </dd>
1510 </dl></div>
1511 </div>
1512 <div class="sect3">
1513 <h4 id="_defining_an_external_diff_driver">Defining an external diff driver</h4>
1514 <div class="paragraph"><p>The definition of a diff driver is done in <code>gitconfig</code>, not
1515 <code>gitattributes</code> file, so strictly speaking this manual page is a
1516 wrong place to talk about it.  However&#8230;</p></div>
1517 <div class="paragraph"><p>To define an external diff driver <code>jcdiff</code>, add a section to your
1518 <code>$GIT_DIR/config</code> file (or <code>$HOME/.gitconfig</code> file) like this:</p></div>
1519 <div class="listingblock">
1520 <div class="content">
1521 <pre><code>[diff "jcdiff"]
1522         command = j-c-diff</code></pre>
1523 </div></div>
1524 <div class="paragraph"><p>When Git needs to show you a diff for the path with <code>diff</code>
1525 attribute set to <code>jcdiff</code>, it calls the command you specified
1526 with the above configuration, i.e. <code>j-c-diff</code>, with 7
1527 parameters, just like <code>GIT_EXTERNAL_DIFF</code> program is called.
1528 See <a href="git.html">git(1)</a> for details.</p></div>
1529 </div>
1530 <div class="sect3">
1531 <h4 id="_defining_a_custom_hunk_header">Defining a custom hunk-header</h4>
1532 <div class="paragraph"><p>Each group of changes (called a "hunk") in the textual diff output
1533 is prefixed with a line of the form:</p></div>
1534 <div class="literalblock">
1535 <div class="content">
1536 <pre><code>@@ -k,l +n,m @@ TEXT</code></pre>
1537 </div></div>
1538 <div class="paragraph"><p>This is called a <em>hunk header</em>.  The "TEXT" portion is by default a line
1539 that begins with an alphabet, an underscore or a dollar sign; this
1540 matches what GNU <em>diff -p</em> output uses.  This default selection however
1541 is not suited for some contents, and you can use a customized pattern
1542 to make a selection.</p></div>
1543 <div class="paragraph"><p>First, in .gitattributes, you would assign the <code>diff</code> attribute
1544 for paths.</p></div>
1545 <div class="listingblock">
1546 <div class="content">
1547 <pre><code>*.tex   diff=tex</code></pre>
1548 </div></div>
1549 <div class="paragraph"><p>Then, you would define a "diff.tex.xfuncname" configuration to
1550 specify a regular expression that matches a line that you would
1551 want to appear as the hunk header "TEXT". Add a section to your
1552 <code>$GIT_DIR/config</code> file (or <code>$HOME/.gitconfig</code> file) like this:</p></div>
1553 <div class="listingblock">
1554 <div class="content">
1555 <pre><code>[diff "tex"]
1556         xfuncname = "^(\\\\(sub)*section\\{.*)$"</code></pre>
1557 </div></div>
1558 <div class="paragraph"><p>Note.  A single level of backslashes are eaten by the
1559 configuration file parser, so you would need to double the
1560 backslashes; the pattern above picks a line that begins with a
1561 backslash, and zero or more occurrences of <code>sub</code> followed by
1562 <code>section</code> followed by open brace, to the end of line.</p></div>
1563 <div class="paragraph"><p>There are a few built-in patterns to make this easier, and <code>tex</code>
1564 is one of them, so you do not have to write the above in your
1565 configuration file (you still need to enable this with the
1566 attribute mechanism, via <code>.gitattributes</code>).  The following built in
1567 patterns are available:</p></div>
1568 <div class="ulist"><ul>
1569 <li>
1570 <p>
1571 <code>ada</code> suitable for source code in the Ada language.
1572 </p>
1573 </li>
1574 <li>
1575 <p>
1576 <code>bash</code> suitable for source code in the Bourne-Again SHell language.
1577   Covers a superset of POSIX shell function definitions.
1578 </p>
1579 </li>
1580 <li>
1581 <p>
1582 <code>bibtex</code> suitable for files with BibTeX coded references.
1583 </p>
1584 </li>
1585 <li>
1586 <p>
1587 <code>cpp</code> suitable for source code in the C and C++ languages.
1588 </p>
1589 </li>
1590 <li>
1591 <p>
1592 <code>csharp</code> suitable for source code in the C# language.
1593 </p>
1594 </li>
1595 <li>
1596 <p>
1597 <code>css</code> suitable for cascading style sheets.
1598 </p>
1599 </li>
1600 <li>
1601 <p>
1602 <code>dts</code> suitable for devicetree (DTS) files.
1603 </p>
1604 </li>
1605 <li>
1606 <p>
1607 <code>elixir</code> suitable for source code in the Elixir language.
1608 </p>
1609 </li>
1610 <li>
1611 <p>
1612 <code>fortran</code> suitable for source code in the Fortran language.
1613 </p>
1614 </li>
1615 <li>
1616 <p>
1617 <code>fountain</code> suitable for Fountain documents.
1618 </p>
1619 </li>
1620 <li>
1621 <p>
1622 <code>golang</code> suitable for source code in the Go language.
1623 </p>
1624 </li>
1625 <li>
1626 <p>
1627 <code>html</code> suitable for HTML/XHTML documents.
1628 </p>
1629 </li>
1630 <li>
1631 <p>
1632 <code>java</code> suitable for source code in the Java language.
1633 </p>
1634 </li>
1635 <li>
1636 <p>
1637 <code>kotlin</code> suitable for source code in the Kotlin language.
1638 </p>
1639 </li>
1640 <li>
1641 <p>
1642 <code>markdown</code> suitable for Markdown documents.
1643 </p>
1644 </li>
1645 <li>
1646 <p>
1647 <code>matlab</code> suitable for source code in the MATLAB and Octave languages.
1648 </p>
1649 </li>
1650 <li>
1651 <p>
1652 <code>objc</code> suitable for source code in the Objective-C language.
1653 </p>
1654 </li>
1655 <li>
1656 <p>
1657 <code>pascal</code> suitable for source code in the Pascal/Delphi language.
1658 </p>
1659 </li>
1660 <li>
1661 <p>
1662 <code>perl</code> suitable for source code in the Perl language.
1663 </p>
1664 </li>
1665 <li>
1666 <p>
1667 <code>php</code> suitable for source code in the PHP language.
1668 </p>
1669 </li>
1670 <li>
1671 <p>
1672 <code>python</code> suitable for source code in the Python language.
1673 </p>
1674 </li>
1675 <li>
1676 <p>
1677 <code>ruby</code> suitable for source code in the Ruby language.
1678 </p>
1679 </li>
1680 <li>
1681 <p>
1682 <code>rust</code> suitable for source code in the Rust language.
1683 </p>
1684 </li>
1685 <li>
1686 <p>
1687 <code>scheme</code> suitable for source code in the Scheme language.
1688 </p>
1689 </li>
1690 <li>
1691 <p>
1692 <code>tex</code> suitable for source code for LaTeX documents.
1693 </p>
1694 </li>
1695 </ul></div>
1696 </div>
1697 <div class="sect3">
1698 <h4 id="_customizing_word_diff">Customizing word diff</h4>
1699 <div class="paragraph"><p>You can customize the rules that <code>git diff --word-diff</code> uses to
1700 split words in a line, by specifying an appropriate regular expression
1701 in the "diff.*.wordRegex" configuration variable.  For example, in TeX
1702 a backslash followed by a sequence of letters forms a command, but
1703 several such commands can be run together without intervening
1704 whitespace.  To separate them, use a regular expression in your
1705 <code>$GIT_DIR/config</code> file (or <code>$HOME/.gitconfig</code> file) like this:</p></div>
1706 <div class="listingblock">
1707 <div class="content">
1708 <pre><code>[diff "tex"]
1709         wordRegex = "\\\\[a-zA-Z]+|[{}]|\\\\.|[^\\{}[:space:]]+"</code></pre>
1710 </div></div>
1711 <div class="paragraph"><p>A built-in pattern is provided for all languages listed in the
1712 previous section.</p></div>
1713 </div>
1714 <div class="sect3">
1715 <h4 id="_performing_text_diffs_of_binary_files">Performing text diffs of binary files</h4>
1716 <div class="paragraph"><p>Sometimes it is desirable to see the diff of a text-converted
1717 version of some binary files. For example, a word processor
1718 document can be converted to an ASCII text representation, and
1719 the diff of the text shown. Even though this conversion loses
1720 some information, the resulting diff is useful for human
1721 viewing (but cannot be applied directly).</p></div>
1722 <div class="paragraph"><p>The <code>textconv</code> config option is used to define a program for
1723 performing such a conversion. The program should take a single
1724 argument, the name of a file to convert, and produce the
1725 resulting text on stdout.</p></div>
1726 <div class="paragraph"><p>For example, to show the diff of the exif information of a
1727 file instead of the binary information (assuming you have the
1728 exif tool installed), add the following section to your
1729 <code>$GIT_DIR/config</code> file (or <code>$HOME/.gitconfig</code> file):</p></div>
1730 <div class="listingblock">
1731 <div class="content">
1732 <pre><code>[diff "jpg"]
1733         textconv = exif</code></pre>
1734 </div></div>
1735 <div class="admonitionblock">
1736 <table><tr>
1737 <td class="icon">
1738 <div class="title">Note</div>
1739 </td>
1740 <td class="content">The text conversion is generally a one-way conversion;
1741 in this example, we lose the actual image contents and focus
1742 just on the text data. This means that diffs generated by
1743 textconv are <em>not</em> suitable for applying. For this reason,
1744 only <code>git diff</code> and the <code>git log</code> family of commands (i.e.,
1745 log, whatchanged, show) will perform text conversion. <code>git
1746 format-patch</code> will never generate this output. If you want to
1747 send somebody a text-converted diff of a binary file (e.g.,
1748 because it quickly conveys the changes you have made), you
1749 should generate it separately and send it as a comment <em>in
1750 addition to</em> the usual binary diff that you might send.</td>
1751 </tr></table>
1752 </div>
1753 <div class="paragraph"><p>Because text conversion can be slow, especially when doing a
1754 large number of them with <code>git log -p</code>, Git provides a mechanism
1755 to cache the output and use it in future diffs.  To enable
1756 caching, set the "cachetextconv" variable in your diff driver&#8217;s
1757 config. For example:</p></div>
1758 <div class="listingblock">
1759 <div class="content">
1760 <pre><code>[diff "jpg"]
1761         textconv = exif
1762         cachetextconv = true</code></pre>
1763 </div></div>
1764 <div class="paragraph"><p>This will cache the result of running "exif" on each blob
1765 indefinitely. If you change the textconv config variable for a
1766 diff driver, Git will automatically invalidate the cache entries
1767 and re-run the textconv filter. If you want to invalidate the
1768 cache manually (e.g., because your version of "exif" was updated
1769 and now produces better output), you can remove the cache
1770 manually with <code>git update-ref -d refs/notes/textconv/jpg</code> (where
1771 "jpg" is the name of the diff driver, as in the example above).</p></div>
1772 </div>
1773 <div class="sect3">
1774 <h4 id="_choosing_textconv_versus_external_diff">Choosing textconv versus external diff</h4>
1775 <div class="paragraph"><p>If you want to show differences between binary or specially-formatted
1776 blobs in your repository, you can choose to use either an external diff
1777 command, or to use textconv to convert them to a diff-able text format.
1778 Which method you choose depends on your exact situation.</p></div>
1779 <div class="paragraph"><p>The advantage of using an external diff command is flexibility. You are
1780 not bound to find line-oriented changes, nor is it necessary for the
1781 output to resemble unified diff. You are free to locate and report
1782 changes in the most appropriate way for your data format.</p></div>
1783 <div class="paragraph"><p>A textconv, by comparison, is much more limiting. You provide a
1784 transformation of the data into a line-oriented text format, and Git
1785 uses its regular diff tools to generate the output. There are several
1786 advantages to choosing this method:</p></div>
1787 <div class="olist arabic"><ol class="arabic">
1788 <li>
1789 <p>
1790 Ease of use. It is often much simpler to write a binary to text
1791    transformation than it is to perform your own diff. In many cases,
1792    existing programs can be used as textconv filters (e.g., exif,
1793    odt2txt).
1794 </p>
1795 </li>
1796 <li>
1797 <p>
1798 Git diff features. By performing only the transformation step
1799    yourself, you can still utilize many of Git&#8217;s diff features,
1800    including colorization, word-diff, and combined diffs for merges.
1801 </p>
1802 </li>
1803 <li>
1804 <p>
1805 Caching. Textconv caching can speed up repeated diffs, such as those
1806    you might trigger by running <code>git log -p</code>.
1807 </p>
1808 </li>
1809 </ol></div>
1810 </div>
1811 <div class="sect3">
1812 <h4 id="_marking_files_as_binary">Marking files as binary</h4>
1813 <div class="paragraph"><p>Git usually guesses correctly whether a blob contains text or binary
1814 data by examining the beginning of the contents. However, sometimes you
1815 may want to override its decision, either because a blob contains binary
1816 data later in the file, or because the content, while technically
1817 composed of text characters, is opaque to a human reader. For example,
1818 many postscript files contain only ASCII characters, but produce noisy
1819 and meaningless diffs.</p></div>
1820 <div class="paragraph"><p>The simplest way to mark a file as binary is to unset the diff
1821 attribute in the <code>.gitattributes</code> file:</p></div>
1822 <div class="listingblock">
1823 <div class="content">
1824 <pre><code>*.ps -diff</code></pre>
1825 </div></div>
1826 <div class="paragraph"><p>This will cause Git to generate <code>Binary files differ</code> (or a binary
1827 patch, if binary patches are enabled) instead of a regular diff.</p></div>
1828 <div class="paragraph"><p>However, one may also want to specify other diff driver attributes. For
1829 example, you might want to use <code>textconv</code> to convert postscript files to
1830 an ASCII representation for human viewing, but otherwise treat them as
1831 binary files. You cannot specify both <code>-diff</code> and <code>diff=ps</code> attributes.
1832 The solution is to use the <code>diff.*.binary</code> config option:</p></div>
1833 <div class="listingblock">
1834 <div class="content">
1835 <pre><code>[diff "ps"]
1836   textconv = ps2ascii
1837   binary = true</code></pre>
1838 </div></div>
1839 </div>
1840 </div>
1841 <div class="sect2">
1842 <h3 id="_performing_a_three_way_merge">Performing a three-way merge</h3>
1843 <div class="sect3">
1844 <h4 id="_code_merge_code"><code>merge</code></h4>
1845 <div class="paragraph"><p>The attribute <code>merge</code> affects how three versions of a file are
1846 merged when a file-level merge is necessary during <code>git merge</code>,
1847 and other commands such as <code>git revert</code> and <code>git cherry-pick</code>.</p></div>
1848 <div class="dlist"><dl>
1849 <dt class="hdlist1">
1850 Set
1851 </dt>
1852 <dd>
1853 <p>
1854         Built-in 3-way merge driver is used to merge the
1855         contents in a way similar to <em>merge</em> command of <code>RCS</code>
1856         suite.  This is suitable for ordinary text files.
1857 </p>
1858 </dd>
1859 <dt class="hdlist1">
1860 Unset
1861 </dt>
1862 <dd>
1863 <p>
1864         Take the version from the current branch as the
1865         tentative merge result, and declare that the merge has
1866         conflicts.  This is suitable for binary files that do
1867         not have a well-defined merge semantics.
1868 </p>
1869 </dd>
1870 <dt class="hdlist1">
1871 Unspecified
1872 </dt>
1873 <dd>
1874 <p>
1875         By default, this uses the same built-in 3-way merge
1876         driver as is the case when the <code>merge</code> attribute is set.
1877         However, the <code>merge.default</code> configuration variable can name
1878         different merge driver to be used with paths for which the
1879         <code>merge</code> attribute is unspecified.
1880 </p>
1881 </dd>
1882 <dt class="hdlist1">
1883 String
1884 </dt>
1885 <dd>
1886 <p>
1887         3-way merge is performed using the specified custom
1888         merge driver.  The built-in 3-way merge driver can be
1889         explicitly specified by asking for "text" driver; the
1890         built-in "take the current branch" driver can be
1891         requested with "binary".
1892 </p>
1893 </dd>
1894 </dl></div>
1895 </div>
1896 <div class="sect3">
1897 <h4 id="_built_in_merge_drivers">Built-in merge drivers</h4>
1898 <div class="paragraph"><p>There are a few built-in low-level merge drivers defined that
1899 can be asked for via the <code>merge</code> attribute.</p></div>
1900 <div class="dlist"><dl>
1901 <dt class="hdlist1">
1902 text
1903 </dt>
1904 <dd>
1905 <p>
1906         Usual 3-way file level merge for text files.  Conflicted
1907         regions are marked with conflict markers <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code>,
1908         <code>=======</code> and <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code>.  The version from your branch
1909         appears before the <code>=======</code> marker, and the version
1910         from the merged branch appears after the <code>=======</code>
1911         marker.
1912 </p>
1913 </dd>
1914 <dt class="hdlist1">
1915 binary
1916 </dt>
1917 <dd>
1918 <p>
1919         Keep the version from your branch in the work tree, but
1920         leave the path in the conflicted state for the user to
1921         sort out.
1922 </p>
1923 </dd>
1924 <dt class="hdlist1">
1925 union
1926 </dt>
1927 <dd>
1928 <p>
1929         Run 3-way file level merge for text files, but take
1930         lines from both versions, instead of leaving conflict
1931         markers.  This tends to leave the added lines in the
1932         resulting file in random order and the user should
1933         verify the result. Do not use this if you do not
1934         understand the implications.
1935 </p>
1936 </dd>
1937 </dl></div>
1938 </div>
1939 <div class="sect3">
1940 <h4 id="_defining_a_custom_merge_driver">Defining a custom merge driver</h4>
1941 <div class="paragraph"><p>The definition of a merge driver is done in the <code>.git/config</code>
1942 file, not in the <code>gitattributes</code> file, so strictly speaking this
1943 manual page is a wrong place to talk about it.  However&#8230;</p></div>
1944 <div class="paragraph"><p>To define a custom merge driver <code>filfre</code>, add a section to your
1945 <code>$GIT_DIR/config</code> file (or <code>$HOME/.gitconfig</code> file) like this:</p></div>
1946 <div class="listingblock">
1947 <div class="content">
1948 <pre><code>[merge "filfre"]
1949         name = feel-free merge driver
1950         driver = filfre %O %A %B %L %P
1951         recursive = binary</code></pre>
1952 </div></div>
1953 <div class="paragraph"><p>The <code>merge.*.name</code> variable gives the driver a human-readable
1954 name.</p></div>
1955 <div class="paragraph"><p>The &#8216;merge.*.driver` variable&#8217;s value is used to construct a
1956 command to run to merge ancestor&#8217;s version (<code>%O</code>), current
1957 version (<code>%A</code>) and the other branches&#8217; version (<code>%B</code>).  These
1958 three tokens are replaced with the names of temporary files that
1959 hold the contents of these versions when the command line is
1960 built. Additionally, %L will be replaced with the conflict marker
1961 size (see below).</p></div>
1962 <div class="paragraph"><p>The merge driver is expected to leave the result of the merge in
1963 the file named with <code>%A</code> by overwriting it, and exit with zero
1964 status if it managed to merge them cleanly, or non-zero if there
1965 were conflicts.</p></div>
1966 <div class="paragraph"><p>The <code>merge.*.recursive</code> variable specifies what other merge
1967 driver to use when the merge driver is called for an internal
1968 merge between common ancestors, when there are more than one.
1969 When left unspecified, the driver itself is used for both
1970 internal merge and the final merge.</p></div>
1971 <div class="paragraph"><p>The merge driver can learn the pathname in which the merged result
1972 will be stored via placeholder <code>%P</code>.</p></div>
1973 </div>
1974 <div class="sect3">
1975 <h4 id="_code_conflict_marker_size_code"><code>conflict-marker-size</code></h4>
1976 <div class="paragraph"><p>This attribute controls the length of conflict markers left in
1977 the work tree file during a conflicted merge.  Only setting to
1978 the value to a positive integer has any meaningful effect.</p></div>
1979 <div class="paragraph"><p>For example, this line in <code>.gitattributes</code> can be used to tell the merge
1980 machinery to leave much longer (instead of the usual 7-character-long)
1981 conflict markers when merging the file <code>Documentation/git-merge.txt</code>
1982 results in a conflict.</p></div>
1983 <div class="listingblock">
1984 <div class="content">
1985 <pre><code>Documentation/git-merge.txt     conflict-marker-size=32</code></pre>
1986 </div></div>
1987 </div>
1988 </div>
1989 <div class="sect2">
1990 <h3 id="_checking_whitespace_errors">Checking whitespace errors</h3>
1991 <div class="sect3">
1992 <h4 id="_code_whitespace_code"><code>whitespace</code></h4>
1993 <div class="paragraph"><p>The <code>core.whitespace</code> configuration variable allows you to define what
1994 <em>diff</em> and <em>apply</em> should consider whitespace errors for all paths in
1995 the project (See <a href="git-config.html">git-config(1)</a>).  This attribute gives you finer
1996 control per path.</p></div>
1997 <div class="dlist"><dl>
1998 <dt class="hdlist1">
1999 Set
2000 </dt>
2001 <dd>
2002 <p>
2003         Notice all types of potential whitespace errors known to Git.
2004         The tab width is taken from the value of the <code>core.whitespace</code>
2005         configuration variable.
2006 </p>
2007 </dd>
2008 <dt class="hdlist1">
2009 Unset
2010 </dt>
2011 <dd>
2012 <p>
2013         Do not notice anything as error.
2014 </p>
2015 </dd>
2016 <dt class="hdlist1">
2017 Unspecified
2018 </dt>
2019 <dd>
2020 <p>
2021         Use the value of the <code>core.whitespace</code> configuration variable to
2022         decide what to notice as error.
2023 </p>
2024 </dd>
2025 <dt class="hdlist1">
2026 String
2027 </dt>
2028 <dd>
2029 <p>
2030         Specify a comma separated list of common whitespace problems to
2031         notice in the same format as the <code>core.whitespace</code> configuration
2032         variable.
2033 </p>
2034 </dd>
2035 </dl></div>
2036 </div>
2037 </div>
2038 <div class="sect2">
2039 <h3 id="_creating_an_archive">Creating an archive</h3>
2040 <div class="sect3">
2041 <h4 id="_code_export_ignore_code"><code>export-ignore</code></h4>
2042 <div class="paragraph"><p>Files and directories with the attribute <code>export-ignore</code> won&#8217;t be added to
2043 archive files.</p></div>
2044 </div>
2045 <div class="sect3">
2046 <h4 id="_code_export_subst_code"><code>export-subst</code></h4>
2047 <div class="paragraph"><p>If the attribute <code>export-subst</code> is set for a file then Git will expand
2048 several placeholders when adding this file to an archive.  The
2049 expansion depends on the availability of a commit ID, i.e., if
2050 <a href="git-archive.html">git-archive(1)</a> has been given a tree instead of a commit or a
2051 tag then no replacement will be done.  The placeholders are the same
2052 as those for the option <code>--pretty=format:</code> of <a href="git-log.html">git-log(1)</a>,
2053 except that they need to be wrapped like this: <code>$Format:PLACEHOLDERS$</code>
2054 in the file.  E.g. the string <code>$Format:%H$</code> will be replaced by the
2055 commit hash.  However, only one <code>%(describe)</code> placeholder is expanded
2056 per archive to avoid denial-of-service attacks.</p></div>
2057 </div>
2058 </div>
2059 <div class="sect2">
2060 <h3 id="_packing_objects">Packing objects</h3>
2061 <div class="sect3">
2062 <h4 id="_code_delta_code"><code>delta</code></h4>
2063 <div class="paragraph"><p>Delta compression will not be attempted for blobs for paths with the
2064 attribute <code>delta</code> set to false.</p></div>
2065 </div>
2066 </div>
2067 <div class="sect2">
2068 <h3 id="_viewing_files_in_gui_tools">Viewing files in GUI tools</h3>
2069 <div class="sect3">
2070 <h4 id="_code_encoding_code"><code>encoding</code></h4>
2071 <div class="paragraph"><p>The value of this attribute specifies the character encoding that should
2072 be used by GUI tools (e.g. <a href="gitk.html">gitk(1)</a> and <a href="git-gui.html">git-gui(1)</a>) to
2073 display the contents of the relevant file. Note that due to performance
2074 considerations <a href="gitk.html">gitk(1)</a> does not use this attribute unless you
2075 manually enable per-file encodings in its options.</p></div>
2076 <div class="paragraph"><p>If this attribute is not set or has an invalid value, the value of the
2077 <code>gui.encoding</code> configuration variable is used instead
2078 (See <a href="git-config.html">git-config(1)</a>).</p></div>
2079 </div>
2080 </div>
2081 </div>
2082 </div>
2083 <div class="sect1">
2084 <h2 id="_using_macro_attributes">USING MACRO ATTRIBUTES</h2>
2085 <div class="sectionbody">
2086 <div class="paragraph"><p>You do not want any end-of-line conversions applied to, nor textual diffs
2087 produced for, any binary file you track.  You would need to specify e.g.</p></div>
2088 <div class="listingblock">
2089 <div class="content">
2090 <pre><code>*.jpg -text -diff</code></pre>
2091 </div></div>
2092 <div class="paragraph"><p>but that may become cumbersome, when you have many attributes.  Using
2093 macro attributes, you can define an attribute that, when set, also
2094 sets or unsets a number of other attributes at the same time.  The
2095 system knows a built-in macro attribute, <code>binary</code>:</p></div>
2096 <div class="listingblock">
2097 <div class="content">
2098 <pre><code>*.jpg binary</code></pre>
2099 </div></div>
2100 <div class="paragraph"><p>Setting the "binary" attribute also unsets the "text" and "diff"
2101 attributes as above.  Note that macro attributes can only be "Set",
2102 though setting one might have the effect of setting or unsetting other
2103 attributes or even returning other attributes to the "Unspecified"
2104 state.</p></div>
2105 </div>
2106 </div>
2107 <div class="sect1">
2108 <h2 id="_defining_macro_attributes">DEFINING MACRO ATTRIBUTES</h2>
2109 <div class="sectionbody">
2110 <div class="paragraph"><p>Custom macro attributes can be defined only in top-level gitattributes
2111 files (<code>$GIT_DIR/info/attributes</code>, the <code>.gitattributes</code> file at the
2112 top level of the working tree, or the global or system-wide
2113 gitattributes files), not in <code>.gitattributes</code> files in working tree
2114 subdirectories.  The built-in macro attribute "binary" is equivalent
2115 to:</p></div>
2116 <div class="listingblock">
2117 <div class="content">
2118 <pre><code>[attr]binary -diff -merge -text</code></pre>
2119 </div></div>
2120 </div>
2121 </div>
2122 <div class="sect1">
2123 <h2 id="_notes">NOTES</h2>
2124 <div class="sectionbody">
2125 <div class="paragraph"><p>Git does not follow symbolic links when accessing a <code>.gitattributes</code>
2126 file in the working tree. This keeps behavior consistent when the file
2127 is accessed from the index or a tree versus from the filesystem.</p></div>
2128 </div>
2129 </div>
2130 <div class="sect1">
2131 <h2 id="_examples">EXAMPLES</h2>
2132 <div class="sectionbody">
2133 <div class="paragraph"><p>If you have these three <code>gitattributes</code> file:</p></div>
2134 <div class="listingblock">
2135 <div class="content">
2136 <pre><code>(in $GIT_DIR/info/attributes)
2137
2138 a*      foo !bar -baz
2139
2140 (in .gitattributes)
2141 abc     foo bar baz
2142
2143 (in t/.gitattributes)
2144 ab*     merge=filfre
2145 abc     -foo -bar
2146 *.c     frotz</code></pre>
2147 </div></div>
2148 <div class="paragraph"><p>the attributes given to path <code>t/abc</code> are computed as follows:</p></div>
2149 <div class="olist arabic"><ol class="arabic">
2150 <li>
2151 <p>
2152 By examining <code>t/.gitattributes</code> (which is in the same
2153    directory as the path in question), Git finds that the first
2154    line matches.  <code>merge</code> attribute is set.  It also finds that
2155    the second line matches, and attributes <code>foo</code> and <code>bar</code>
2156    are unset.
2157 </p>
2158 </li>
2159 <li>
2160 <p>
2161 Then it examines <code>.gitattributes</code> (which is in the parent
2162    directory), and finds that the first line matches, but
2163    <code>t/.gitattributes</code> file already decided how <code>merge</code>, <code>foo</code>
2164    and <code>bar</code> attributes should be given to this path, so it
2165    leaves <code>foo</code> and <code>bar</code> unset.  Attribute <code>baz</code> is set.
2166 </p>
2167 </li>
2168 <li>
2169 <p>
2170 Finally it examines <code>$GIT_DIR/info/attributes</code>.  This file
2171    is used to override the in-tree settings.  The first line is
2172    a match, and <code>foo</code> is set, <code>bar</code> is reverted to unspecified
2173    state, and <code>baz</code> is unset.
2174 </p>
2175 </li>
2176 </ol></div>
2177 <div class="paragraph"><p>As the result, the attributes assignment to <code>t/abc</code> becomes:</p></div>
2178 <div class="listingblock">
2179 <div class="content">
2180 <pre><code>foo     set to true
2181 bar     unspecified
2182 baz     set to false
2183 merge   set to string value "filfre"
2184 frotz   unspecified</code></pre>
2185 </div></div>
2186 </div>
2187 </div>
2188 <div class="sect1">
2189 <h2 id="_see_also">SEE ALSO</h2>
2190 <div class="sectionbody">
2191 <div class="paragraph"><p><a href="git-check-attr.html">git-check-attr(1)</a>.</p></div>
2192 </div>
2193 </div>
2194 <div class="sect1">
2195 <h2 id="_git">GIT</h2>
2196 <div class="sectionbody">
2197 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
2198 </div>
2199 </div>
2200 </div>
2201 <div id="footnotes"><hr /></div>
2202 <div id="footer">
2203 <div id="footer-text">
2204 Last updated
2205  2023-01-05 15:32:44 JST
2206 </div>
2207 </div>
2208 </body>
2209 </html>