technical/api-gitattributes.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6 <meta name="generator" content="AsciiDoc 8.4.5" />
   7 <title>gitattributes API</title>
   8 <style type="text/css">
   9 /* Debug borders */
  10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  11 /*
  12   border: 1px solid red;
  13 */
  14 }
  15
  16 body {
  17   margin: 1em 5% 1em 5%;
  18 }
  19
  20 a {
  21   color: blue;
  22   text-decoration: underline;
  23 }
  24 a:visited {
  25   color: fuchsia;
  26 }
  27
  28 em {
  29   font-style: italic;
  30   color: navy;
  31 }
  32
  33 strong {
  34   font-weight: bold;
  35   color: #083194;
  36 }
  37
  38 tt {
  39   color: navy;
  40 }
  41
  42 h1, h2, h3, h4, h5, h6 {
  43   color: #527bbd;
  44   font-family: sans-serif;
  45   margin-top: 1.2em;
  46   margin-bottom: 0.5em;
  47   line-height: 1.3;
  48 }
  49
  50 h1, h2, h3 {
  51   border-bottom: 2px solid silver;
  52 }
  53 h2 {
  54   padding-top: 0.5em;
  55 }
  56 h3 {
  57   float: left;
  58 }
  59 h3 + * {
  60   clear: left;
  61 }
  62
  63 div.sectionbody {
  64   font-family: serif;
  65   margin-left: 0;
  66 }
  67
  68 hr {
  69   border: 1px solid silver;
  70 }
  71
  72 p {
  73   margin-top: 0.5em;
  74   margin-bottom: 0.5em;
  75 }
  76
  77 ul, ol, li > p {
  78   margin-top: 0;
  79 }
  80
  81 pre {
  82   padding: 0;
  83   margin: 0;
  84 }
  85
  86 span#author {
  87   color: #527bbd;
  88   font-family: sans-serif;
  89   font-weight: bold;
  90   font-size: 1.1em;
  91 }
  92 span#email {
  93 }
  94 span#revnumber, span#revdate, span#revremark {
  95   font-family: sans-serif;
  96 }
  97
  98 div#footer {
  99   font-family: sans-serif;
 100   font-size: small;
 101   border-top: 2px solid silver;
 102   padding-top: 0.5em;
 103   margin-top: 4.0em;
 104 }
 105 div#footer-text {
 106   float: left;
 107   padding-bottom: 0.5em;
 108 }
 109 div#footer-badges {
 110   float: right;
 111   padding-bottom: 0.5em;
 112 }
 113
 114 div#preamble {
 115   margin-top: 1.5em;
 116   margin-bottom: 1.5em;
 117 }
 118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 120 div.admonitionblock {
 121   margin-top: 1.5em;
 122   margin-bottom: 1.5em;
 123 }
 124 div.admonitionblock {
 125   margin-top: 2.5em;
 126   margin-bottom: 2.5em;
 127 }
 128
 129 div.content { /* Block element content. */
 130   padding: 0;
 131 }
 132
 133 /* Block element titles. */
 134 div.title, caption.title {
 135   color: #527bbd;
 136   font-family: sans-serif;
 137   font-weight: bold;
 138   text-align: left;
 139   margin-top: 1.0em;
 140   margin-bottom: 0.5em;
 141 }
 142 div.title + * {
 143   margin-top: 0;
 144 }
 145
 146 td div.title:first-child {
 147   margin-top: 0.0em;
 148 }
 149 div.content div.title:first-child {
 150   margin-top: 0.0em;
 151 }
 152 div.content + div.title {
 153   margin-top: 0.0em;
 154 }
 155
 156 div.sidebarblock > div.content {
 157   background: #ffffee;
 158   border: 1px solid silver;
 159   padding: 0.5em;
 160 }
 161
 162 div.listingblock > div.content {
 163   border: 1px solid silver;
 164   background: #f4f4f4;
 165   padding: 0.5em;
 166 }
 167
 168 div.quoteblock {
 169   padding-left: 2.0em;
 170   margin-right: 10%;
 171 }
 172 div.quoteblock > div.attribution {
 173   padding-top: 0.5em;
 174   text-align: right;
 175 }
 176
 177 div.verseblock {
 178   padding-left: 2.0em;
 179   margin-right: 10%;
 180 }
 181 div.verseblock > div.content {
 182   white-space: pre;
 183 }
 184 div.verseblock > div.attribution {
 185   padding-top: 0.75em;
 186   text-align: left;
 187 }
 188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 189 div.verseblock + div.attribution {
 190   text-align: left;
 191 }
 192
 193 div.admonitionblock .icon {
 194   vertical-align: top;
 195   font-size: 1.1em;
 196   font-weight: bold;
 197   text-decoration: underline;
 198   color: #527bbd;
 199   padding-right: 0.5em;
 200 }
 201 div.admonitionblock td.content {
 202   padding-left: 0.5em;
 203   border-left: 2px solid silver;
 204 }
 205
 206 div.exampleblock > div.content {
 207   border-left: 2px solid silver;
 208   padding: 0.5em;
 209 }
 210
 211 div.imageblock div.content { padding-left: 0; }
 212 span.image img { border-style: none; }
 213 a.image:visited { color: white; }
 214
 215 dl {
 216   margin-top: 0.8em;
 217   margin-bottom: 0.8em;
 218 }
 219 dt {
 220   margin-top: 0.5em;
 221   margin-bottom: 0;
 222   font-style: normal;
 223   color: navy;
 224 }
 225 dd > *:first-child {
 226   margin-top: 0.1em;
 227 }
 228
 229 ul, ol {
 230     list-style-position: outside;
 231 }
 232 ol.arabic {
 233   list-style-type: decimal;
 234 }
 235 ol.loweralpha {
 236   list-style-type: lower-alpha;
 237 }
 238 ol.upperalpha {
 239   list-style-type: upper-alpha;
 240 }
 241 ol.lowerroman {
 242   list-style-type: lower-roman;
 243 }
 244 ol.upperroman {
 245   list-style-type: upper-roman;
 246 }
 247
 248 div.compact ul, div.compact ol,
 249 div.compact p, div.compact p,
 250 div.compact div, div.compact div {
 251   margin-top: 0.1em;
 252   margin-bottom: 0.1em;
 253 }
 254
 255 div.tableblock > table {
 256   border: 3px solid #527bbd;
 257 }
 258 thead {
 259   font-family: sans-serif;
 260   font-weight: bold;
 261 }
 262 tfoot {
 263   font-weight: bold;
 264 }
 265 td > div.verse {
 266   white-space: pre;
 267 }
 268 p.table {
 269   margin-top: 0;
 270 }
 271 /* Because the table frame attribute is overriden by CSS in most browsers. */
 272 div.tableblock > table[frame="void"] {
 273   border-style: none;
 274 }
 275 div.tableblock > table[frame="hsides"] {
 276   border-left-style: none;
 277   border-right-style: none;
 278 }
 279 div.tableblock > table[frame="vsides"] {
 280   border-top-style: none;
 281   border-bottom-style: none;
 282 }
 283
 284
 285 div.hdlist {
 286   margin-top: 0.8em;
 287   margin-bottom: 0.8em;
 288 }
 289 div.hdlist tr {
 290   padding-bottom: 15px;
 291 }
 292 dt.hdlist1.strong, td.hdlist1.strong {
 293   font-weight: bold;
 294 }
 295 td.hdlist1 {
 296   vertical-align: top;
 297   font-style: normal;
 298   padding-right: 0.8em;
 299   color: navy;
 300 }
 301 td.hdlist2 {
 302   vertical-align: top;
 303 }
 304 div.hdlist.compact tr {
 305   margin: 0;
 306   padding-bottom: 0;
 307 }
 308
 309 .comment {
 310   background: yellow;
 311 }
 312
 313 @media print {
 314   div#footer-badges { display: none; }
 315 }
 316
 317 div#toctitle {
 318   color: #527bbd;
 319   font-family: sans-serif;
 320   font-size: 1.1em;
 321   font-weight: bold;
 322   margin-top: 1.0em;
 323   margin-bottom: 0.1em;
 324 }
 325
 326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 327   margin-top: 0;
 328   margin-bottom: 0;
 329 }
 330 div.toclevel2 {
 331   margin-left: 2em;
 332   font-size: 0.9em;
 333 }
 334 div.toclevel3 {
 335   margin-left: 4em;
 336   font-size: 0.9em;
 337 }
 338 div.toclevel4 {
 339   margin-left: 6em;
 340   font-size: 0.9em;
 341 }
 342 /* Workarounds for IE6's broken and incomplete CSS2. */
 343
 344 div.sidebar-content {
 345   background: #ffffee;
 346   border: 1px solid silver;
 347   padding: 0.5em;
 348 }
 349 div.sidebar-title, div.image-title {
 350   color: #527bbd;
 351   font-family: sans-serif;
 352   font-weight: bold;
 353   margin-top: 0.0em;
 354   margin-bottom: 0.5em;
 355 }
 356
 357 div.listingblock div.content {
 358   border: 1px solid silver;
 359   background: #f4f4f4;
 360   padding: 0.5em;
 361 }
 362
 363 div.quoteblock-attribution {
 364   padding-top: 0.5em;
 365   text-align: right;
 366 }
 367
 368 div.verseblock-content {
 369   white-space: pre;
 370 }
 371 div.verseblock-attribution {
 372   padding-top: 0.75em;
 373   text-align: left;
 374 }
 375
 376 div.exampleblock-content {
 377   border-left: 2px solid silver;
 378   padding-left: 0.5em;
 379 }
 380
 381 /* IE6 sets dynamically generated links as visited. */
 382 div#toc a:visited { color: blue; }
 383 </style>
 384 </head>
 385 <body>
 386 <div id="header">
 387 <h1>gitattributes API</h1>
 388 </div>
 389 <div id="preamble">
 390 <div class="sectionbody">
 391 <div class="paragraph"><p>gitattributes mechanism gives a uniform way to associate various
 392 attributes to set of paths.</p></div>
 393 </div>
 394 </div>
 395 <h2 id="_data_structure">Data Structure</h2>
 396 <div class="sectionbody">
 397 <div class="dlist"><dl>
 398 <dt class="hdlist1">
 399 <tt>struct git_attr</tt>
 400 </dt>
 401 <dd>
 402 <p>
 403         An attribute is an opaque object that is identified by its name.
 404         Pass the name and its length to <tt>git_attr()</tt> function to obtain
 405         the object of this type.  The internal representation of this
 406         structure is of no interest to the calling programs.
 407 </p>
 408 </dd>
 409 <dt class="hdlist1">
 410 <tt>struct git_attr_check</tt>
 411 </dt>
 412 <dd>
 413 <p>
 414         This structure represents a set of attributes to check in a call
 415         to <tt>git_checkattr()</tt> function, and receives the results.
 416 </p>
 417 </dd>
 418 </dl></div>
 419 </div>
 420 <h2 id="_calling_sequence">Calling Sequence</h2>
 421 <div class="sectionbody">
 422 <div class="ulist"><ul>
 423 <li>
 424 <p>
 425 Prepare an array of <tt>struct git_attr_check</tt> to define the list of
 426   attributes you would want to check.  To populate this array, you would
 427   need to define necessary attributes by calling <tt>git_attr()</tt> function.
 428 </p>
 429 </li>
 430 <li>
 431 <p>
 432 Call git_checkattr() to check the attributes for the path.
 433 </p>
 434 </li>
 435 <li>
 436 <p>
 437 Inspect <tt>git_attr_check</tt> structure to see how each of the attribute in
 438   the array is defined for the path.
 439 </p>
 440 </li>
 441 </ul></div>
 442 </div>
 443 <h2 id="_attribute_values">Attribute Values</h2>
 444 <div class="sectionbody">
 445 <div class="paragraph"><p>An attribute for a path can be in one of four states: Set, Unset,
 446 Unspecified or set to a string, and <tt>.value</tt> member of <tt>struct
 447 git_attr_check</tt> records it.  There are three macros to check these:</p></div>
 448 <div class="dlist"><dl>
 449 <dt class="hdlist1">
 450 <tt>ATTR_TRUE()</tt>
 451 </dt>
 452 <dd>
 453 <p>
 454         Returns true if the attribute is Set for the path.
 455 </p>
 456 </dd>
 457 <dt class="hdlist1">
 458 <tt>ATTR_FALSE()</tt>
 459 </dt>
 460 <dd>
 461 <p>
 462         Returns true if the attribute is Unset for the path.
 463 </p>
 464 </dd>
 465 <dt class="hdlist1">
 466 <tt>ATTR_UNSET()</tt>
 467 </dt>
 468 <dd>
 469 <p>
 470         Returns true if the attribute is Unspecified for the path.
 471 </p>
 472 </dd>
 473 </dl></div>
 474 <div class="paragraph"><p>If none of the above returns true, <tt>.value</tt> member points at a string
 475 value of the attribute for the path.</p></div>
 476 </div>
 477 <h2 id="_example">Example</h2>
 478 <div class="sectionbody">
 479 <div class="paragraph"><p>To see how attributes "crlf" and "indent" are set for different paths.</p></div>
 480 <div class="olist arabic"><ol class="arabic">
 481 <li>
 482 <p>
 483 Prepare an array of <tt>struct git_attr_check</tt> with two elements (because
 484   we are checking two attributes).  Initialize their <tt>attr</tt> member with
 485   pointers to <tt>struct git_attr</tt> obtained by calling <tt>git_attr()</tt>:
 486 </p>
 487 </li>
 488 </ol></div>
 489 <div class="listingblock">
 490 <div class="content">
 491 <pre><tt>static struct git_attr_check check[2];
 492 static void setup_check(void)
 493 {
 494         if (check[0].attr)
 495                 return; /* already done */
 496         check[0].attr = git_attr("crlf", 4);
 497         check[1].attr = git_attr("ident", 5);
 498 }</tt></pre>
 499 </div></div>
 500 <div class="olist arabic"><ol class="arabic">
 501 <li>
 502 <p>
 503 Call <tt>git_checkattr()</tt> with the prepared array of <tt>struct git_attr_check</tt>:
 504 </p>
 505 </li>
 506 </ol></div>
 507 <div class="listingblock">
 508 <div class="content">
 509 <pre><tt>        const char *path;
 510
 511         setup_check();
 512         git_checkattr(path, ARRAY_SIZE(check), check);</tt></pre>
 513 </div></div>
 514 <div class="olist arabic"><ol class="arabic">
 515 <li>
 516 <p>
 517 Act on <tt>.value</tt> member of the result, left in <tt>check[]</tt>:
 518 </p>
 519 </li>
 520 </ol></div>
 521 <div class="listingblock">
 522 <div class="content">
 523 <pre><tt>        const char *value = check[0].value;
 524
 525         if (ATTR_TRUE(value)) {
 526                 The attribute is Set, by listing only the name of the
 527                 attribute in the gitattributes file for the path.
 528         } else if (ATTR_FALSE(value)) {
 529                 The attribute is Unset, by listing the name of the
 530                 attribute prefixed with a dash - for the path.
 531         } else if (ATTR_UNSET(value)) {
 532                 The attribute is not set nor unset for the path.
 533         } else if (!strcmp(value, "input")) {
 534                 If none of ATTR_TRUE(), ATTR_FALSE(), or ATTR_UNSET() is
 535                 true, the value is a string set in the gitattributes
 536                 file for the path by saying "attr=value".
 537         } else if (... other check using value as string ...) {
 538                 ...
 539         }</tt></pre>
 540 </div></div>
 541 <div class="paragraph"><p>(JC)</p></div>
 542 </div>
 543 <div id="footer">
 544 <div id="footer-text">
 545 Last updated 2008-09-19 06:28:28 UTC
 546 </div>
 547 </div>
 548 </body>
 549 </html>