]>
Commit | Line | Data |
---|---|---|
88e7fdf2 JH |
1 | gitattributes(5) |
2 | ================ | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | gitattributes - defining attributes per path | |
7 | ||
8 | SYNOPSIS | |
9 | -------- | |
e5b5c1d2 | 10 | $GIT_DIR/info/attributes, .gitattributes |
88e7fdf2 JH |
11 | |
12 | ||
13 | DESCRIPTION | |
14 | ----------- | |
15 | ||
16 | A `gitattributes` file is a simple text file that gives | |
17 | `attributes` to pathnames. | |
18 | ||
19 | Each line in `gitattributes` file is of form: | |
20 | ||
21 | glob attr1 attr2 ... | |
22 | ||
23 | That is, a glob pattern followed by an attributes list, | |
24 | separated by whitespaces. When the glob pattern matches the | |
25 | path in question, the attributes listed on the line are given to | |
26 | the path. | |
27 | ||
28 | Each attribute can be in one of these states for a given path: | |
29 | ||
30 | Set:: | |
31 | ||
32 | The path has the attribute with special value "true"; | |
33 | this is specified by listing only the name of the | |
34 | attribute in the attribute list. | |
35 | ||
36 | Unset:: | |
37 | ||
38 | The path has the attribute with special value "false"; | |
39 | this is specified by listing the name of the attribute | |
40 | prefixed with a dash `-` in the attribute list. | |
41 | ||
42 | Set to a value:: | |
43 | ||
44 | The path has the attribute with specified string value; | |
45 | this is specified by listing the name of the attribute | |
46 | followed by an equal sign `=` and its value in the | |
47 | attribute list. | |
48 | ||
49 | Unspecified:: | |
50 | ||
51 | No glob pattern matches the path, and nothing says if | |
b9d14ffb JH |
52 | the path has or does not have the attribute, the |
53 | attribute for the path is said to be Unspecified. | |
88e7fdf2 JH |
54 | |
55 | When more than one glob pattern matches the path, a later line | |
b9d14ffb JH |
56 | overrides an earlier line. This overriding is done per |
57 | attribute. | |
88e7fdf2 JH |
58 | |
59 | When deciding what attributes are assigned to a path, git | |
60 | consults `$GIT_DIR/info/attributes` file (which has the highest | |
61 | precedence), `.gitattributes` file in the same directory as the | |
62 | path in question, and its parent directories (the further the | |
63 | directory that contains `.gitattributes` is from the path in | |
64 | question, the lower its precedence). | |
65 | ||
90b22907 JK |
66 | If you wish to affect only a single repository (i.e., to assign |
67 | attributes to files that are particular to one user's workflow), then | |
68 | attributes should be placed in the `$GIT_DIR/info/attributes` file. | |
69 | Attributes which should be version-controlled and distributed to other | |
70 | repositories (i.e., attributes of interest to all users) should go into | |
71 | `.gitattributes` files. | |
72 | ||
88e7fdf2 JH |
73 | Sometimes you would need to override an setting of an attribute |
74 | for a path to `unspecified` state. This can be done by listing | |
75 | the name of the attribute prefixed with an exclamation point `!`. | |
76 | ||
77 | ||
78 | EFFECTS | |
79 | ------- | |
80 | ||
81 | Certain operations by git can be influenced by assigning | |
ae7aa499 JH |
82 | particular attributes to a path. Currently, the following |
83 | operations are attributes-aware. | |
88e7fdf2 JH |
84 | |
85 | Checking-out and checking-in | |
86 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
87 | ||
3fed15f5 | 88 | These attributes affect how the contents stored in the |
88e7fdf2 | 89 | repository are copied to the working tree files when commands |
ba020ef5 | 90 | such as 'git-checkout' and 'git-merge' run. They also affect how |
88e7fdf2 | 91 | git stores the contents you prepare in the working tree in the |
ba020ef5 | 92 | repository upon 'git-add' and 'git-commit'. |
88e7fdf2 | 93 | |
3fed15f5 JH |
94 | `crlf` |
95 | ^^^^^^ | |
96 | ||
97 | This attribute controls the line-ending convention. | |
98 | ||
88e7fdf2 JH |
99 | Set:: |
100 | ||
101 | Setting the `crlf` attribute on a path is meant to mark | |
102 | the path as a "text" file. 'core.autocrlf' conversion | |
103 | takes place without guessing the content type by | |
104 | inspection. | |
105 | ||
106 | Unset:: | |
107 | ||
bbb896d8 JH |
108 | Unsetting the `crlf` attribute on a path tells git not to |
109 | attempt any end-of-line conversion upon checkin or checkout. | |
88e7fdf2 JH |
110 | |
111 | Unspecified:: | |
112 | ||
113 | Unspecified `crlf` attribute tells git to apply the | |
114 | `core.autocrlf` conversion when the file content looks | |
115 | like text. | |
116 | ||
117 | Set to string value "input":: | |
118 | ||
119 | This is similar to setting the attribute to `true`, but | |
120 | also forces git to act as if `core.autocrlf` is set to | |
121 | `input` for the path. | |
122 | ||
123 | Any other value set to `crlf` attribute is ignored and git acts | |
124 | as if the attribute is left unspecified. | |
125 | ||
126 | ||
127 | The `core.autocrlf` conversion | |
128 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
129 | ||
130 | If the configuration variable `core.autocrlf` is false, no | |
131 | conversion is done. | |
132 | ||
133 | When `core.autocrlf` is true, it means that the platform wants | |
134 | CRLF line endings for files in the working tree, and you want to | |
135 | convert them back to the normal LF line endings when checking | |
136 | in to the repository. | |
137 | ||
138 | When `core.autocrlf` is set to "input", line endings are | |
139 | converted to LF upon checkin, but there is no conversion done | |
140 | upon checkout. | |
141 | ||
21e5ad50 SP |
142 | If `core.safecrlf` is set to "true" or "warn", git verifies if |
143 | the conversion is reversible for the current setting of | |
144 | `core.autocrlf`. For "true", git rejects irreversible | |
145 | conversions; for "warn", git only prints a warning but accepts | |
146 | an irreversible conversion. The safety triggers to prevent such | |
147 | a conversion done to the files in the work tree, but there are a | |
148 | few exceptions. Even though... | |
149 | ||
ba020ef5 | 150 | - 'git-add' itself does not touch the files in the work tree, the |
21e5ad50 SP |
151 | next checkout would, so the safety triggers; |
152 | ||
ba020ef5 | 153 | - 'git-apply' to update a text file with a patch does touch the files |
21e5ad50 SP |
154 | in the work tree, but the operation is about text files and CRLF |
155 | conversion is about fixing the line ending inconsistencies, so the | |
156 | safety does not trigger; | |
157 | ||
ba020ef5 JN |
158 | - 'git-diff' itself does not touch the files in the work tree, it is |
159 | often run to inspect the changes you intend to next 'git-add'. To | |
21e5ad50 SP |
160 | catch potential problems early, safety triggers. |
161 | ||
88e7fdf2 | 162 | |
3fed15f5 JH |
163 | `ident` |
164 | ^^^^^^^ | |
165 | ||
2c850f12 JK |
166 | When the attribute `ident` is set for a path, git replaces |
167 | `$Id$` in the blob object with `$Id:`, followed by the | |
3fed15f5 JH |
168 | 40-character hexadecimal blob object name, followed by a dollar |
169 | sign `$` upon checkout. Any byte sequence that begins with | |
af9b54bb AP |
170 | `$Id:` and ends with `$` in the worktree file is replaced |
171 | with `$Id$` upon check-in. | |
3fed15f5 JH |
172 | |
173 | ||
aa4ed402 JH |
174 | `filter` |
175 | ^^^^^^^^ | |
176 | ||
c05ef938 | 177 | A `filter` attribute can be set to a string value that names a |
aa4ed402 JH |
178 | filter driver specified in the configuration. |
179 | ||
c05ef938 | 180 | A filter driver consists of a `clean` command and a `smudge` |
aa4ed402 | 181 | command, either of which can be left unspecified. Upon |
c05ef938 WC |
182 | checkout, when the `smudge` command is specified, the command is |
183 | fed the blob object from its standard input, and its standard | |
184 | output is used to update the worktree file. Similarly, the | |
185 | `clean` command is used to convert the contents of worktree file | |
186 | upon checkin. | |
aa4ed402 | 187 | |
c05ef938 | 188 | A missing filter driver definition in the config is not an error |
aa4ed402 JH |
189 | but makes the filter a no-op passthru. |
190 | ||
191 | The content filtering is done to massage the content into a | |
192 | shape that is more convenient for the platform, filesystem, and | |
c05ef938 | 193 | the user to use. The key phrase here is "more convenient" and not |
4d84aff3 JS |
194 | "turning something unusable into usable". In other words, the |
195 | intent is that if someone unsets the filter driver definition, | |
196 | or does not have the appropriate filter program, the project | |
197 | should still be usable. | |
aa4ed402 JH |
198 | |
199 | ||
200 | Interaction between checkin/checkout attributes | |
201 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
202 | ||
203 | In the check-in codepath, the worktree file is first converted | |
204 | with `filter` driver (if specified and corresponding driver | |
205 | defined), then the result is processed with `ident` (if | |
206 | specified), and then finally with `crlf` (again, if specified | |
207 | and applicable). | |
208 | ||
209 | In the check-out codepath, the blob content is first converted | |
210 | with `crlf`, and then `ident` and fed to `filter`. | |
211 | ||
212 | ||
88e7fdf2 JH |
213 | Generating diff text |
214 | ~~~~~~~~~~~~~~~~~~~~ | |
215 | ||
4f73e240 JN |
216 | `diff` |
217 | ^^^^^^ | |
218 | ||
678852d9 JK |
219 | The attribute `diff` affects how 'git' generates diffs for particular |
220 | files. It can tell git whether to generate a textual patch for the path | |
221 | or to treat the path as a binary file. It can also affect what line is | |
222 | shown on the hunk header `@@ -k,l +n,m @@` line, tell git to use an | |
223 | external command to generate the diff, or ask git to convert binary | |
224 | files to a text format before generating the diff. | |
88e7fdf2 JH |
225 | |
226 | Set:: | |
227 | ||
228 | A path to which the `diff` attribute is set is treated | |
229 | as text, even when they contain byte values that | |
230 | normally never appear in text files, such as NUL. | |
231 | ||
232 | Unset:: | |
233 | ||
234 | A path to which the `diff` attribute is unset will | |
678852d9 JK |
235 | generate `Binary files differ` (or a binary patch, if |
236 | binary patches are enabled). | |
88e7fdf2 JH |
237 | |
238 | Unspecified:: | |
239 | ||
240 | A path to which the `diff` attribute is unspecified | |
241 | first gets its contents inspected, and if it looks like | |
242 | text, it is treated as text. Otherwise it would | |
243 | generate `Binary files differ`. | |
244 | ||
2cc3167c JH |
245 | String:: |
246 | ||
678852d9 JK |
247 | Diff is shown using the specified diff driver. Each driver may |
248 | specify one or more options, as described in the following | |
249 | section. The options for the diff driver "foo" are defined | |
250 | by the configuration variables in the "diff.foo" section of the | |
251 | git config file. | |
2cc3167c JH |
252 | |
253 | ||
678852d9 JK |
254 | Defining an external diff driver |
255 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
2cc3167c JH |
256 | |
257 | The definition of a diff driver is done in `gitconfig`, not | |
258 | `gitattributes` file, so strictly speaking this manual page is a | |
259 | wrong place to talk about it. However... | |
260 | ||
678852d9 | 261 | To define an external diff driver `jcdiff`, add a section to your |
2cc3167c JH |
262 | `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this: |
263 | ||
264 | ---------------------------------------------------------------- | |
265 | [diff "jcdiff"] | |
266 | command = j-c-diff | |
267 | ---------------------------------------------------------------- | |
268 | ||
269 | When git needs to show you a diff for the path with `diff` | |
270 | attribute set to `jcdiff`, it calls the command you specified | |
271 | with the above configuration, i.e. `j-c-diff`, with 7 | |
272 | parameters, just like `GIT_EXTERNAL_DIFF` program is called. | |
9e1f0a85 | 273 | See linkgit:git[1] for details. |
88e7fdf2 JH |
274 | |
275 | ||
ae7aa499 JH |
276 | Defining a custom hunk-header |
277 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
278 | ||
c882c01e | 279 | Each group of changes (called a "hunk") in the textual diff output |
ae7aa499 JH |
280 | is prefixed with a line of the form: |
281 | ||
282 | @@ -k,l +n,m @@ TEXT | |
283 | ||
c882c01e GD |
284 | This is called a 'hunk header'. The "TEXT" portion is by default a line |
285 | that begins with an alphabet, an underscore or a dollar sign; this | |
286 | matches what GNU 'diff -p' output uses. This default selection however | |
287 | is not suited for some contents, and you can use a customized pattern | |
288 | to make a selection. | |
ae7aa499 | 289 | |
c882c01e | 290 | First, in .gitattributes, you would assign the `diff` attribute |
ae7aa499 JH |
291 | for paths. |
292 | ||
293 | ------------------------ | |
294 | *.tex diff=tex | |
295 | ------------------------ | |
296 | ||
edb7e82f | 297 | Then, you would define a "diff.tex.xfuncname" configuration to |
ae7aa499 | 298 | specify a regular expression that matches a line that you would |
c882c01e | 299 | want to appear as the hunk header "TEXT", like this: |
ae7aa499 JH |
300 | |
301 | ------------------------ | |
302 | [diff "tex"] | |
45d9414f | 303 | xfuncname = "^(\\\\(sub)*section\\{.*)$" |
ae7aa499 JH |
304 | ------------------------ |
305 | ||
306 | Note. A single level of backslashes are eaten by the | |
307 | configuration file parser, so you would need to double the | |
308 | backslashes; the pattern above picks a line that begins with a | |
02783075 | 309 | backslash, and zero or more occurrences of `sub` followed by |
ae7aa499 JH |
310 | `section` followed by open brace, to the end of line. |
311 | ||
312 | There are a few built-in patterns to make this easier, and `tex` | |
313 | is one of them, so you do not have to write the above in your | |
314 | configuration file (you still need to enable this with the | |
d08ed6d6 GH |
315 | attribute mechanism, via `.gitattributes`). The following built in |
316 | patterns are available: | |
317 | ||
23b5beb2 GH |
318 | - `bibtex` suitable for files with BibTeX coded references. |
319 | ||
80c49c3d TR |
320 | - `cpp` suitable for source code in the C and C++ languages. |
321 | ||
af9ce1ff AE |
322 | - `html` suitable for HTML/XHTML documents. |
323 | ||
b66e00f1 | 324 | - `java` suitable for source code in the Java language. |
d08ed6d6 | 325 | |
5d1e958e JS |
326 | - `objc` suitable for source code in the Objective-C language. |
327 | ||
d08ed6d6 GH |
328 | - `pascal` suitable for source code in the Pascal/Delphi language. |
329 | ||
af9ce1ff AE |
330 | - `php` suitable for source code in the PHP language. |
331 | ||
7c17205b KS |
332 | - `python` suitable for source code in the Python language. |
333 | ||
d08ed6d6 GH |
334 | - `ruby` suitable for source code in the Ruby language. |
335 | ||
336 | - `tex` suitable for source code for LaTeX documents. | |
ae7aa499 JH |
337 | |
338 | ||
80c49c3d TR |
339 | Customizing word diff |
340 | ^^^^^^^^^^^^^^^^^^^^^ | |
341 | ||
342 | You can customize the rules that `git diff --color-words` uses to | |
343 | split words in a line, by specifying an appropriate regular expression | |
344 | in the "diff.*.wordregex" configuration variable. For example, in TeX | |
345 | a backslash followed by a sequence of letters forms a command, but | |
346 | several such commands can be run together without intervening | |
347 | whitespace. To separate them, use a regular expression such as | |
348 | ||
349 | ------------------------ | |
350 | [diff "tex"] | |
351 | wordregex = "\\\\[a-zA-Z]+|[{}]|\\\\.|[^\\{}[:space:]]+" | |
352 | ------------------------ | |
353 | ||
354 | A built-in pattern is provided for all languages listed in the | |
355 | previous section. | |
356 | ||
357 | ||
678852d9 JK |
358 | Performing text diffs of binary files |
359 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
360 | ||
361 | Sometimes it is desirable to see the diff of a text-converted | |
362 | version of some binary files. For example, a word processor | |
363 | document can be converted to an ASCII text representation, and | |
364 | the diff of the text shown. Even though this conversion loses | |
365 | some information, the resulting diff is useful for human | |
366 | viewing (but cannot be applied directly). | |
367 | ||
368 | The `textconv` config option is used to define a program for | |
369 | performing such a conversion. The program should take a single | |
370 | argument, the name of a file to convert, and produce the | |
371 | resulting text on stdout. | |
372 | ||
373 | For example, to show the diff of the exif information of a | |
374 | file instead of the binary information (assuming you have the | |
375 | exif tool installed): | |
376 | ||
377 | ------------------------ | |
378 | [diff "jpg"] | |
379 | textconv = exif | |
380 | ------------------------ | |
381 | ||
382 | NOTE: The text conversion is generally a one-way conversion; | |
383 | in this example, we lose the actual image contents and focus | |
384 | just on the text data. This means that diffs generated by | |
385 | textconv are _not_ suitable for applying. For this reason, | |
386 | only `git diff` and the `git log` family of commands (i.e., | |
387 | log, whatchanged, show) will perform text conversion. `git | |
388 | format-patch` will never generate this output. If you want to | |
389 | send somebody a text-converted diff of a binary file (e.g., | |
390 | because it quickly conveys the changes you have made), you | |
391 | should generate it separately and send it as a comment _in | |
392 | addition to_ the usual binary diff that you might send. | |
393 | ||
394 | ||
88e7fdf2 JH |
395 | Performing a three-way merge |
396 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
397 | ||
4f73e240 JN |
398 | `merge` |
399 | ^^^^^^^ | |
400 | ||
88e7fdf2 JH |
401 | The attribute `merge` affects how three versions of a file is |
402 | merged when a file-level merge is necessary during `git merge`, | |
403 | and other programs such as `git revert` and `git cherry-pick`. | |
404 | ||
405 | Set:: | |
406 | ||
407 | Built-in 3-way merge driver is used to merge the | |
2fd02c92 | 408 | contents in a way similar to 'merge' command of `RCS` |
88e7fdf2 JH |
409 | suite. This is suitable for ordinary text files. |
410 | ||
411 | Unset:: | |
412 | ||
413 | Take the version from the current branch as the | |
414 | tentative merge result, and declare that the merge has | |
415 | conflicts. This is suitable for binary files that does | |
416 | not have a well-defined merge semantics. | |
417 | ||
418 | Unspecified:: | |
419 | ||
420 | By default, this uses the same built-in 3-way merge | |
421 | driver as is the case the `merge` attribute is set. | |
422 | However, `merge.default` configuration variable can name | |
423 | different merge driver to be used for paths to which the | |
424 | `merge` attribute is unspecified. | |
425 | ||
2cc3167c | 426 | String:: |
88e7fdf2 JH |
427 | |
428 | 3-way merge is performed using the specified custom | |
429 | merge driver. The built-in 3-way merge driver can be | |
430 | explicitly specified by asking for "text" driver; the | |
431 | built-in "take the current branch" driver can be | |
b9d14ffb | 432 | requested with "binary". |
88e7fdf2 JH |
433 | |
434 | ||
0e545f75 JH |
435 | Built-in merge drivers |
436 | ^^^^^^^^^^^^^^^^^^^^^^ | |
437 | ||
438 | There are a few built-in low-level merge drivers defined that | |
439 | can be asked for via the `merge` attribute. | |
440 | ||
441 | text:: | |
442 | ||
443 | Usual 3-way file level merge for text files. Conflicted | |
444 | regions are marked with conflict markers `<<<<<<<`, | |
445 | `=======` and `>>>>>>>`. The version from your branch | |
446 | appears before the `=======` marker, and the version | |
447 | from the merged branch appears after the `=======` | |
448 | marker. | |
449 | ||
450 | binary:: | |
451 | ||
452 | Keep the version from your branch in the work tree, but | |
453 | leave the path in the conflicted state for the user to | |
454 | sort out. | |
455 | ||
456 | union:: | |
457 | ||
458 | Run 3-way file level merge for text files, but take | |
459 | lines from both versions, instead of leaving conflict | |
460 | markers. This tends to leave the added lines in the | |
461 | resulting file in random order and the user should | |
462 | verify the result. Do not use this if you do not | |
463 | understand the implications. | |
464 | ||
465 | ||
88e7fdf2 JH |
466 | Defining a custom merge driver |
467 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
468 | ||
0e545f75 JH |
469 | The definition of a merge driver is done in the `.git/config` |
470 | file, not in the `gitattributes` file, so strictly speaking this | |
471 | manual page is a wrong place to talk about it. However... | |
88e7fdf2 JH |
472 | |
473 | To define a custom merge driver `filfre`, add a section to your | |
474 | `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this: | |
475 | ||
476 | ---------------------------------------------------------------- | |
477 | [merge "filfre"] | |
478 | name = feel-free merge driver | |
479 | driver = filfre %O %A %B | |
480 | recursive = binary | |
481 | ---------------------------------------------------------------- | |
482 | ||
483 | The `merge.*.name` variable gives the driver a human-readable | |
484 | name. | |
485 | ||
486 | The `merge.*.driver` variable's value is used to construct a | |
487 | command to run to merge ancestor's version (`%O`), current | |
488 | version (`%A`) and the other branches' version (`%B`). These | |
489 | three tokens are replaced with the names of temporary files that | |
490 | hold the contents of these versions when the command line is | |
491 | built. | |
492 | ||
493 | The merge driver is expected to leave the result of the merge in | |
494 | the file named with `%A` by overwriting it, and exit with zero | |
495 | status if it managed to merge them cleanly, or non-zero if there | |
496 | were conflicts. | |
497 | ||
498 | The `merge.*.recursive` variable specifies what other merge | |
499 | driver to use when the merge driver is called for an internal | |
500 | merge between common ancestors, when there are more than one. | |
501 | When left unspecified, the driver itself is used for both | |
502 | internal merge and the final merge. | |
503 | ||
504 | ||
cf1b7869 JH |
505 | Checking whitespace errors |
506 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
507 | ||
508 | `whitespace` | |
509 | ^^^^^^^^^^^^ | |
510 | ||
511 | The `core.whitespace` configuration variable allows you to define what | |
2fd02c92 | 512 | 'diff' and 'apply' should consider whitespace errors for all paths in |
5162e697 | 513 | the project (See linkgit:git-config[1]). This attribute gives you finer |
cf1b7869 JH |
514 | control per path. |
515 | ||
516 | Set:: | |
517 | ||
518 | Notice all types of potential whitespace errors known to git. | |
519 | ||
520 | Unset:: | |
521 | ||
522 | Do not notice anything as error. | |
523 | ||
524 | Unspecified:: | |
525 | ||
526 | Use the value of `core.whitespace` configuration variable to | |
527 | decide what to notice as error. | |
528 | ||
529 | String:: | |
530 | ||
531 | Specify a comma separate list of common whitespace problems to | |
532 | notice in the same format as `core.whitespace` configuration | |
533 | variable. | |
534 | ||
535 | ||
8a33dd8b JH |
536 | Creating an archive |
537 | ~~~~~~~~~~~~~~~~~~~ | |
538 | ||
08b51f51 JH |
539 | `export-ignore` |
540 | ^^^^^^^^^^^^^^^ | |
541 | ||
542 | Files and directories with the attribute `export-ignore` won't be added to | |
543 | archive files. | |
544 | ||
8a33dd8b JH |
545 | `export-subst` |
546 | ^^^^^^^^^^^^^^ | |
547 | ||
548 | If the attribute `export-subst` is set for a file then git will expand | |
549 | several placeholders when adding this file to an archive. The | |
08b51f51 | 550 | expansion depends on the availability of a commit ID, i.e., if |
8a33dd8b JH |
551 | linkgit:git-archive[1] has been given a tree instead of a commit or a |
552 | tag then no replacement will be done. The placeholders are the same | |
553 | as those for the option `--pretty=format:` of linkgit:git-log[1], | |
554 | except that they need to be wrapped like this: `$Format:PLACEHOLDERS$` | |
555 | in the file. E.g. the string `$Format:%H$` will be replaced by the | |
556 | commit hash. | |
557 | ||
558 | ||
a2df1fb2 AG |
559 | Viewing files in GUI tools |
560 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
561 | ||
562 | `encoding` | |
563 | ^^^^^^^^^^ | |
564 | ||
565 | The value of this attribute specifies the character encoding that should | |
566 | be used by GUI tools (e.g. linkgit:gitk[1] and linkgit:git-gui[1]) to | |
567 | display the contents of the relevant file. Note that due to performance | |
568 | considerations linkgit:gitk[1] does not use this attribute unless you | |
569 | manually enable per-file encodings in its options. | |
570 | ||
571 | If this attribute is not set or has an invalid value, the value of the | |
572 | `gui.encoding` configuration variable is used instead | |
573 | (See linkgit:git-config[1]). | |
574 | ||
575 | ||
bbb896d8 JH |
576 | USING ATTRIBUTE MACROS |
577 | ---------------------- | |
578 | ||
579 | You do not want any end-of-line conversions applied to, nor textual diffs | |
580 | produced for, any binary file you track. You would need to specify e.g. | |
581 | ||
582 | ------------ | |
583 | *.jpg -crlf -diff | |
584 | ------------ | |
585 | ||
586 | but that may become cumbersome, when you have many attributes. Using | |
587 | attribute macros, you can specify groups of attributes set or unset at | |
588 | the same time. The system knows a built-in attribute macro, `binary`: | |
589 | ||
590 | ------------ | |
591 | *.jpg binary | |
592 | ------------ | |
593 | ||
594 | which is equivalent to the above. Note that the attribute macros can only | |
595 | be "Set" (see the above example that sets "binary" macro as if it were an | |
596 | ordinary attribute --- setting it in turn unsets "crlf" and "diff"). | |
597 | ||
598 | ||
599 | DEFINING ATTRIBUTE MACROS | |
600 | ------------------------- | |
601 | ||
602 | Custom attribute macros can be defined only in the `.gitattributes` file | |
603 | at the toplevel (i.e. not in any subdirectory). The built-in attribute | |
604 | macro "binary" is equivalent to: | |
605 | ||
606 | ------------ | |
607 | [attr]binary -diff -crlf | |
608 | ------------ | |
609 | ||
610 | ||
88e7fdf2 JH |
611 | EXAMPLE |
612 | ------- | |
613 | ||
614 | If you have these three `gitattributes` file: | |
615 | ||
616 | ---------------------------------------------------------------- | |
617 | (in $GIT_DIR/info/attributes) | |
618 | ||
619 | a* foo !bar -baz | |
620 | ||
621 | (in .gitattributes) | |
622 | abc foo bar baz | |
623 | ||
624 | (in t/.gitattributes) | |
625 | ab* merge=filfre | |
626 | abc -foo -bar | |
627 | *.c frotz | |
628 | ---------------------------------------------------------------- | |
629 | ||
630 | the attributes given to path `t/abc` are computed as follows: | |
631 | ||
632 | 1. By examining `t/.gitattributes` (which is in the same | |
02783075 | 633 | directory as the path in question), git finds that the first |
88e7fdf2 JH |
634 | line matches. `merge` attribute is set. It also finds that |
635 | the second line matches, and attributes `foo` and `bar` | |
636 | are unset. | |
637 | ||
638 | 2. Then it examines `.gitattributes` (which is in the parent | |
639 | directory), and finds that the first line matches, but | |
640 | `t/.gitattributes` file already decided how `merge`, `foo` | |
641 | and `bar` attributes should be given to this path, so it | |
642 | leaves `foo` and `bar` unset. Attribute `baz` is set. | |
643 | ||
5c759f96 | 644 | 3. Finally it examines `$GIT_DIR/info/attributes`. This file |
88e7fdf2 JH |
645 | is used to override the in-tree settings. The first line is |
646 | a match, and `foo` is set, `bar` is reverted to unspecified | |
647 | state, and `baz` is unset. | |
648 | ||
02783075 | 649 | As the result, the attributes assignment to `t/abc` becomes: |
88e7fdf2 JH |
650 | |
651 | ---------------------------------------------------------------- | |
652 | foo set to true | |
653 | bar unspecified | |
654 | baz set to false | |
655 | merge set to string value "filfre" | |
656 | frotz unspecified | |
657 | ---------------------------------------------------------------- | |
658 | ||
659 | ||
8460b2fc | 660 | |
88e7fdf2 JH |
661 | GIT |
662 | --- | |
9e1f0a85 | 663 | Part of the linkgit:git[1] suite |