Google Git
Sign in
chromium / external / gitster / git-htmldocs / 02194af879b3d6ac73715fc296d5d9d68b7f8610 / . / technical / api-gitattributes.html
blob: 70efac511d455fa62cfd07c0faee05c8212631e1 [file] [log] [blame]
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]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" />
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]6<meta name="generator" content="AsciiDoc 8.5.2" />
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]7<title>gitattributes API</title>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]8<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]30 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]35 color: #083194;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, 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
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]50h1, h2, h3 {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]90 font-size: 1.1em;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]91}
92span#email {
93}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]95 font-family: sans-serif;
96}
97
98div#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}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]121 margin-top: 1.0em;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]137 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]176}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]177
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]180 text-align: right;
181}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]182
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]194
195div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]205 border-left: 3px solid #dddddd;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]211}
212
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]214span.image img { border-style: none; }
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]215a.image:visited { color: white; }
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]224 font-style: normal;
225 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]228 margin-top: 0.1em;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]238 list-style-type: lower-alpha;
239}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]256
257div.tableblock > table {
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]258 border: 3px solid #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]260thead, p.table.header {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]285
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]286
287div.hdlist {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]293}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]298 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]299 font-style: normal;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]301 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]302}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]303td.hdlist2 {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]304 vertical-align: top;
305}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]314
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
332#footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
340}
341
342
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]351div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]376/* Workarounds for IE6's broken and incomplete CSS2. */
377
378div.sidebar-content {
379 background: #ffffee;
380 border: 1px solid silver;
381 padding: 0.5em;
382}
383div.sidebar-title, div.image-title {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]384 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]385 font-family: sans-serif;
386 font-weight: bold;
387 margin-top: 0.0em;
388 margin-bottom: 0.5em;
389}
390
391div.listingblock div.content {
392 border: 1px solid silver;
393 background: #f4f4f4;
394 padding: 0.5em;
395}
396
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]397div.quoteblock-attribution {
398 padding-top: 0.5em;
399 text-align: right;
400}
401
402div.verseblock-content {
403 white-space: pre;
404}
405div.verseblock-attribution {
406 padding-top: 0.75em;
407 text-align: left;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]408}
409
410div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]411 border-left: 3px solid #dddddd;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]412 padding-left: 0.5em;
413}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]414
415/* IE6 sets dynamically generated links as visited. */
416div#toc a:visited { color: blue; }
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]417</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]418<script type="text/javascript">
419/*<![CDATA[*/
420window.onload = function(){asciidoc.footnotes();}
421var asciidoc = { // Namespace.
422
423/////////////////////////////////////////////////////////////////////
424// Table Of Contents generator
425/////////////////////////////////////////////////////////////////////
426
427/* Author: Mihai Bazon, September 2002
428 * http://students.infoiasi.ro/~mishoo
429 *
430 * Table Of Content generator
431 * Version: 0.4
432 *
433 * Feel free to use this script under the terms of the GNU General Public
434 * License, as long as you do not remove or alter this notice.
435 */
436
437 /* modified by Troy D. Hanson, September 2006. License: GPL */
438 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
439
440// toclevels = 1..4.
441toc: function (toclevels) {
442
443 function getText(el) {
444 var text = "";
445 for (var i = el.firstChild; i != null; i = i.nextSibling) {
446 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
447 text += i.data;
448 else if (i.firstChild != null)
449 text += getText(i);
450 }
451 return text;
452 }
453
454 function TocEntry(el, text, toclevel) {
455 this.element = el;
456 this.text = text;
457 this.toclevel = toclevel;
458 }
459
460 function tocEntries(el, toclevels) {
461 var result = new Array;
462 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
463 // Function that scans the DOM tree for header elements (the DOM2
464 // nodeIterator API would be a better technique but not supported by all
465 // browsers).
466 var iterate = function (el) {
467 for (var i = el.firstChild; i != null; i = i.nextSibling) {
468 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
469 var mo = re.exec(i.tagName);
470 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
471 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
472 }
473 iterate(i);
474 }
475 }
476 }
477 iterate(el);
478 return result;
479 }
480
481 var toc = document.getElementById("toc");
482 var entries = tocEntries(document.getElementById("content"), toclevels);
483 for (var i = 0; i < entries.length; ++i) {
484 var entry = entries[i];
485 if (entry.element.id == "")
486 entry.element.id = "_toc_" + i;
487 var a = document.createElement("a");
488 a.href = "#" + entry.element.id;
489 a.appendChild(document.createTextNode(entry.text));
490 var div = document.createElement("div");
491 div.appendChild(a);
492 div.className = "toclevel" + entry.toclevel;
493 toc.appendChild(div);
494 }
495 if (entries.length == 0)
496 toc.parentNode.removeChild(toc);
497},
498
499
500/////////////////////////////////////////////////////////////////////
501// Footnotes generator
502/////////////////////////////////////////////////////////////////////
503
504/* Based on footnote generation code from:
505 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
506 */
507
508footnotes: function () {
509 var cont = document.getElementById("content");
510 var noteholder = document.getElementById("footnotes");
511 var spans = cont.getElementsByTagName("span");
512 var refs = {};
513 var n = 0;
514 for (i=0; i<spans.length; i++) {
515 if (spans[i].className == "footnote") {
516 n++;
517 // Use [\s\S] in place of . so multi-line matches work.
518 // Because JavaScript has no s (dotall) regex flag.
519 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
520 noteholder.innerHTML +=
521 "<div class='footnote' id='_footnote_" + n + "'>" +
522 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
523 n + "</a>. " + note + "</div>";
524 spans[i].innerHTML =
525 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
526 "' title='View footnote' class='footnote'>" + n + "</a>]";
527 var id =spans[i].getAttribute("id");
528 if (id != null) refs["#"+id] = n;
529 }
530 }
531 if (n == 0)
532 noteholder.parentNode.removeChild(noteholder);
533 else {
534 // Process footnoterefs.
535 for (i=0; i<spans.length; i++) {
536 if (spans[i].className == "footnoteref") {
537 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
538 href = href.match(/#.*/)[0]; // Because IE return full URL.
539 n = refs[href];
540 spans[i].innerHTML =
541 "[<a href='#_footnote_" + n +
542 "' title='View footnote' class='footnote'>" + n + "</a>]";
543 }
544 }
545 }
546}
547
548}
549/*]]>*/
550</script>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]551</head>
552<body>
553<div id="header">
554<h1>gitattributes API</h1>
555</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]556<div id="content">
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]557<div id="preamble">
558<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]559<div class="paragraph"><p>gitattributes mechanism gives a uniform way to associate various
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]560attributes to set of paths.</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]561</div>
562</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]563<h2 id="_data_structure">Data Structure</h2>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]564<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]565<div class="dlist"><dl>
566<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]567<tt>struct git_attr</tt>
568</dt>
569<dd>
570<p>
571 An attribute is an opaque object that is identified by its name.
Junio C Hamanof7279012011-08-18 06:13:13[diff] [blame]572 Pass the name to <tt>git_attr()</tt> function to obtain the object of
573 this type. The internal representation of this structure is
574 of no interest to the calling programs. The name of the
575 attribute can be retrieved by calling <tt>git_attr_name()</tt>.
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]576</p>
577</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]578<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]579<tt>struct git_attr_check</tt>
580</dt>
581<dd>
582<p>
583 This structure represents a set of attributes to check in a call
Junio C Hamanof7279012011-08-18 06:13:13[diff] [blame]584 to <tt>git_check_attr()</tt> function, and receives the results.
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]585</p>
586</dd>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]587</dl></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]588</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]589<h2 id="_attribute_values">Attribute Values</h2>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]590<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]591<div class="paragraph"><p>An attribute for a path can be in one of four states: Set, Unset,
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]592Unspecified or set to a string, and <tt>.value</tt> member of <tt>struct
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]593git_attr_check</tt> records it. There are three macros to check these:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]594<div class="dlist"><dl>
595<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]596<tt>ATTR_TRUE()</tt>
597</dt>
598<dd>
599<p>
600 Returns true if the attribute is Set for the path.
601</p>
602</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]603<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]604<tt>ATTR_FALSE()</tt>
605</dt>
606<dd>
607<p>
608 Returns true if the attribute is Unset for the path.
609</p>
610</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]611<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]612<tt>ATTR_UNSET()</tt>
613</dt>
614<dd>
615<p>
616 Returns true if the attribute is Unspecified for the path.
617</p>
618</dd>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]619</dl></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]620<div class="paragraph"><p>If none of the above returns true, <tt>.value</tt> member points at a string
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]621value of the attribute for the path.</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]622</div>
Junio C Hamanof7279012011-08-18 06:13:13[diff] [blame]623<h2 id="_querying_specific_attributes">Querying Specific Attributes</h2>
624<div class="sectionbody">
625<div class="ulist"><ul>
626<li>
627<p>
628Prepare an array of <tt>struct git_attr_check</tt> to define the list of
629 attributes you would want to check. To populate this array, you would
630 need to define necessary attributes by calling <tt>git_attr()</tt> function.
631</p>
632</li>
633<li>
634<p>
635Call <tt>git_check_attr()</tt> to check the attributes for the path.
636</p>
637</li>
638<li>
639<p>
640Inspect <tt>git_attr_check</tt> structure to see how each of the attribute in
641 the array is defined for the path.
642</p>
643</li>
644</ul></div>
645</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]646<h2 id="_example">Example</h2>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]647<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]648<div class="paragraph"><p>To see how attributes "crlf" and "indent" are set for different paths.</p></div>
649<div class="olist arabic"><ol class="arabic">
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]650<li>
651<p>
652Prepare an array of <tt>struct git_attr_check</tt> with two elements (because
653 we are checking two attributes). Initialize their <tt>attr</tt> member with
654 pointers to <tt>struct git_attr</tt> obtained by calling <tt>git_attr()</tt>:
655</p>
656</li>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]657</ol></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]658<div class="listingblock">
659<div class="content">
660<pre><tt>static struct git_attr_check check[2];
661static void setup_check(void)
662{
663 if (check[0].attr)
664 return; /* already done */
Junio C Hamanof7279012011-08-18 06:13:13[diff] [blame]665 check[0].attr = git_attr("crlf");
666 check[1].attr = git_attr("ident");
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]667}</tt></pre>
668</div></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]669<div class="olist arabic"><ol class="arabic">
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]670<li>
671<p>
Junio C Hamanof7279012011-08-18 06:13:13[diff] [blame]672Call <tt>git_check_attr()</tt> with the prepared array of <tt>struct git_attr_check</tt>:
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]673</p>
674</li>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]675</ol></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]676<div class="listingblock">
677<div class="content">
678<pre><tt> const char *path;
679
680 setup_check();
Junio C Hamanof7279012011-08-18 06:13:13[diff] [blame]681 git_check_attr(path, ARRAY_SIZE(check), check);</tt></pre>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]682</div></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]683<div class="olist arabic"><ol class="arabic">
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]684<li>
685<p>
686Act on <tt>.value</tt> member of the result, left in <tt>check[]</tt>:
687</p>
688</li>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]689</ol></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]690<div class="listingblock">
691<div class="content">
692<pre><tt> const char *value = check[0].value;
693
694 if (ATTR_TRUE(value)) {
695 The attribute is Set, by listing only the name of the
696 attribute in the gitattributes file for the path.
697 } else if (ATTR_FALSE(value)) {
698 The attribute is Unset, by listing the name of the
699 attribute prefixed with a dash - for the path.
700 } else if (ATTR_UNSET(value)) {
701 The attribute is not set nor unset for the path.
702 } else if (!strcmp(value, "input")) {
703 If none of ATTR_TRUE(), ATTR_FALSE(), or ATTR_UNSET() is
704 true, the value is a string set in the gitattributes
705 file for the path by saying "attr=value".
706 } else if (... other check using value as string ...) {
707 ...
708 }</tt></pre>
709</div></div>
Junio C Hamanof7279012011-08-18 06:13:13[diff] [blame]710</div>
711<h2 id="_querying_all_attributes">Querying All Attributes</h2>
712<div class="sectionbody">
713<div class="paragraph"><p>To get the values of all attributes associated with a file:</p></div>
714<div class="ulist"><ul>
715<li>
716<p>
717Call <tt>git_all_attrs()</tt>, which returns an array of <tt>git_attr_check</tt>
718 structures.
719</p>
720</li>
721<li>
722<p>
723Iterate over the <tt>git_attr_check</tt> array to examine the attribute
724 names and values. The name of the attribute described by a
725 <tt>git_attr_check</tt> object can be retrieved via
726 <tt>git_attr_name(check[i].attr)</tt>. (Please note that no items will be
727 returned for unset attributes, so <tt>ATTR_UNSET()</tt> will return false
728 for all returned <tt>git_array_check</tt> objects.)
729</p>
730</li>
731<li>
732<p>
733Free the <tt>git_array_check</tt> array.
734</p>
735</li>
736</ul></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]737</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]738</div>
739<div id="footnotes"><hr /></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]740<div id="footer">
741<div id="footer-text">
Junio C Hamano02194af2011-11-17 20:33:59[diff] [blame^]742Last updated 2011-11-15 13:45:02 PDT
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]743</div>
744</div>
745</body>
746</html>