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