]>
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 | ||
3f74c8e8 | 21 | pattern attr1 attr2 ... |
88e7fdf2 | 22 | |
3f74c8e8 JS |
23 | That is, a pattern followed by an attributes list, |
24 | separated by whitespaces. When the pattern matches the | |
88e7fdf2 JH |
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 | ||
3f74c8e8 | 51 | No 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 | 54 | |
3f74c8e8 | 55 | When more than one pattern matches the path, a later line |
b9d14ffb | 56 | overrides an earlier line. This overriding is done per |
3f74c8e8 JS |
57 | attribute. The rules how the pattern matches paths are the |
58 | same as in `.gitignore` files; see linkgit:gitignore[5]. | |
82dce998 | 59 | Unlike `.gitignore`, negative patterns are forbidden. |
88e7fdf2 | 60 | |
2de9b711 | 61 | When deciding what attributes are assigned to a path, Git |
88e7fdf2 JH |
62 | consults `$GIT_DIR/info/attributes` file (which has the highest |
63 | precedence), `.gitattributes` file in the same directory as the | |
20ff3ec2 JM |
64 | path in question, and its parent directories up to the toplevel of the |
65 | work tree (the further the directory that contains `.gitattributes` | |
6df42ab9 PO |
66 | is from the path in question, the lower its precedence). Finally |
67 | global and system-wide files are considered (they have the lowest | |
68 | precedence). | |
88e7fdf2 | 69 | |
40701adb NTND |
70 | When the `.gitattributes` file is missing from the work tree, the |
71 | path in the index is used as a fall-back. During checkout process, | |
72 | `.gitattributes` in the index is used and then the file in the | |
73 | working tree is used as a fall-back. | |
74 | ||
90b22907 | 75 | If you wish to affect only a single repository (i.e., to assign |
6df42ab9 PO |
76 | attributes to files that are particular to |
77 | one user's workflow for that repository), then | |
90b22907 JK |
78 | attributes should be placed in the `$GIT_DIR/info/attributes` file. |
79 | Attributes which should be version-controlled and distributed to other | |
80 | repositories (i.e., attributes of interest to all users) should go into | |
6df42ab9 PO |
81 | `.gitattributes` files. Attributes that should affect all repositories |
82 | for a single user should be placed in a file specified by the | |
da0005b8 | 83 | `core.attributesFile` configuration option (see linkgit:git-config[1]). |
684e40f6 HKNN |
84 | Its default value is $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME |
85 | is either not set or empty, $HOME/.config/git/attributes is used instead. | |
6df42ab9 PO |
86 | Attributes for all users on a system should be placed in the |
87 | `$(prefix)/etc/gitattributes` file. | |
90b22907 | 88 | |
88e7fdf2 | 89 | Sometimes you would need to override an setting of an attribute |
0922570c | 90 | for a path to `Unspecified` state. This can be done by listing |
88e7fdf2 JH |
91 | the name of the attribute prefixed with an exclamation point `!`. |
92 | ||
93 | ||
94 | EFFECTS | |
95 | ------- | |
96 | ||
2de9b711 | 97 | Certain operations by Git can be influenced by assigning |
ae7aa499 JH |
98 | particular attributes to a path. Currently, the following |
99 | operations are attributes-aware. | |
88e7fdf2 JH |
100 | |
101 | Checking-out and checking-in | |
102 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
103 | ||
3fed15f5 | 104 | These attributes affect how the contents stored in the |
88e7fdf2 | 105 | repository are copied to the working tree files when commands |
0b444cdb | 106 | such as 'git checkout' and 'git merge' run. They also affect how |
2de9b711 | 107 | Git stores the contents you prepare in the working tree in the |
0b444cdb | 108 | repository upon 'git add' and 'git commit'. |
88e7fdf2 | 109 | |
5ec3e670 | 110 | `text` |
3fed15f5 JH |
111 | ^^^^^^ |
112 | ||
fd6cce9e EB |
113 | This attribute enables and controls end-of-line normalization. When a |
114 | text file is normalized, its line endings are converted to LF in the | |
115 | repository. To control what line ending style is used in the working | |
116 | directory, use the `eol` attribute for a single file and the | |
942e7747 | 117 | `core.eol` configuration variable for all text files. |
65237284 | 118 | Note that `core.autocrlf` overrides `core.eol` |
3fed15f5 | 119 | |
88e7fdf2 JH |
120 | Set:: |
121 | ||
5ec3e670 | 122 | Setting the `text` attribute on a path enables end-of-line |
fd6cce9e EB |
123 | normalization and marks the path as a text file. End-of-line |
124 | conversion takes place without guessing the content type. | |
88e7fdf2 JH |
125 | |
126 | Unset:: | |
127 | ||
2de9b711 | 128 | Unsetting the `text` attribute on a path tells Git not to |
bbb896d8 | 129 | attempt any end-of-line conversion upon checkin or checkout. |
88e7fdf2 | 130 | |
fd6cce9e | 131 | Set to string value "auto":: |
88e7fdf2 | 132 | |
5ec3e670 | 133 | When `text` is set to "auto", the path is marked for automatic |
65237284 TB |
134 | end-of-line conversion. If Git decides that the content is |
135 | text, its line endings are converted to LF on checkin. | |
2e3a16b2 | 136 | When the file has been committed with CRLF, no conversion is done. |
88e7fdf2 | 137 | |
88e7fdf2 JH |
138 | Unspecified:: |
139 | ||
2de9b711 | 140 | If the `text` attribute is unspecified, Git uses the |
942e7747 EB |
141 | `core.autocrlf` configuration variable to determine if the |
142 | file should be converted. | |
88e7fdf2 | 143 | |
2de9b711 | 144 | Any other value causes Git to act as if `text` has been left |
fd6cce9e | 145 | unspecified. |
88e7fdf2 | 146 | |
fd6cce9e EB |
147 | `eol` |
148 | ^^^^^ | |
88e7fdf2 | 149 | |
fd6cce9e | 150 | This attribute sets a specific line-ending style to be used in the |
65237284 | 151 | working directory. It enables end-of-line conversion without any |
942e7747 | 152 | content checks, effectively setting the `text` attribute. |
88e7fdf2 | 153 | |
fd6cce9e | 154 | Set to string value "crlf":: |
88e7fdf2 | 155 | |
2de9b711 | 156 | This setting forces Git to normalize line endings for this |
942e7747 EB |
157 | file on checkin and convert them to CRLF when the file is |
158 | checked out. | |
fd6cce9e EB |
159 | |
160 | Set to string value "lf":: | |
161 | ||
2de9b711 | 162 | This setting forces Git to normalize line endings to LF on |
fd6cce9e | 163 | checkin and prevents conversion to CRLF when the file is |
942e7747 | 164 | checked out. |
5ec3e670 EB |
165 | |
166 | Backwards compatibility with `crlf` attribute | |
167 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
168 | ||
169 | For backwards compatibility, the `crlf` attribute is interpreted as | |
170 | follows: | |
171 | ||
172 | ------------------------ | |
173 | crlf text | |
174 | -crlf -text | |
175 | crlf=input eol=lf | |
176 | ------------------------ | |
fd6cce9e EB |
177 | |
178 | End-of-line conversion | |
179 | ^^^^^^^^^^^^^^^^^^^^^^ | |
180 | ||
2de9b711 | 181 | While Git normally leaves file contents alone, it can be configured to |
fd6cce9e EB |
182 | normalize line endings to LF in the repository and, optionally, to |
183 | convert them to CRLF when files are checked out. | |
184 | ||
fd6cce9e EB |
185 | If you simply want to have CRLF line endings in your working directory |
186 | regardless of the repository you are working with, you can set the | |
65237284 | 187 | config variable "core.autocrlf" without using any attributes. |
fd6cce9e EB |
188 | |
189 | ------------------------ | |
190 | [core] | |
191 | autocrlf = true | |
192 | ------------------------ | |
193 | ||
e28eae31 | 194 | This does not force normalization of text files, but does ensure |
fd6cce9e EB |
195 | that text files that you introduce to the repository have their line |
196 | endings normalized to LF when they are added, and that files that are | |
942e7747 | 197 | already normalized in the repository stay normalized. |
fd6cce9e | 198 | |
e28eae31 TB |
199 | If you want to ensure that text files that any contributor introduces to |
200 | the repository have their line endings normalized, you can set the | |
201 | `text` attribute to "auto" for _all_ files. | |
88e7fdf2 | 202 | |
fd6cce9e | 203 | ------------------------ |
5ec3e670 | 204 | * text=auto |
fd6cce9e EB |
205 | ------------------------ |
206 | ||
e28eae31 TB |
207 | The attributes allow a fine-grained control, how the line endings |
208 | are converted. | |
209 | Here is an example that will make Git normalize .txt, .vcproj and .sh | |
210 | files, ensure that .vcproj files have CRLF and .sh files have LF in | |
211 | the working directory, and prevent .jpg files from being normalized | |
212 | regardless of their content. | |
213 | ||
214 | ------------------------ | |
215 | * text=auto | |
216 | *.txt text | |
217 | *.vcproj text eol=crlf | |
218 | *.sh text eol=lf | |
219 | *.jpg -text | |
220 | ------------------------ | |
221 | ||
222 | NOTE: When `text=auto` conversion is enabled in a cross-platform | |
223 | project using push and pull to a central repository the text files | |
224 | containing CRLFs should be normalized. | |
fd6cce9e | 225 | |
e28eae31 | 226 | From a clean working directory: |
fd6cce9e EB |
227 | |
228 | ------------------------------------------------- | |
e28eae31 | 229 | $ echo "* text=auto" >.gitattributes |
2de9b711 | 230 | $ rm .git/index # Remove the index to force Git to |
fd6cce9e EB |
231 | $ git reset # re-scan the working directory |
232 | $ git status # Show files that will be normalized | |
233 | $ git add -u | |
234 | $ git add .gitattributes | |
235 | $ git commit -m "Introduce end-of-line normalization" | |
236 | ------------------------------------------------- | |
237 | ||
238 | If any files that should not be normalized show up in 'git status', | |
5ec3e670 | 239 | unset their `text` attribute before running 'git add -u'. |
fd6cce9e EB |
240 | |
241 | ------------------------ | |
5ec3e670 | 242 | manual.pdf -text |
fd6cce9e | 243 | ------------------------ |
88e7fdf2 | 244 | |
2de9b711 | 245 | Conversely, text files that Git does not detect can have normalization |
fd6cce9e | 246 | enabled manually. |
88e7fdf2 | 247 | |
fd6cce9e | 248 | ------------------------ |
5ec3e670 | 249 | weirdchars.txt text |
fd6cce9e | 250 | ------------------------ |
88e7fdf2 | 251 | |
2de9b711 | 252 | If `core.safecrlf` is set to "true" or "warn", Git verifies if |
21e5ad50 | 253 | the conversion is reversible for the current setting of |
2de9b711 TA |
254 | `core.autocrlf`. For "true", Git rejects irreversible |
255 | conversions; for "warn", Git only prints a warning but accepts | |
21e5ad50 SP |
256 | an irreversible conversion. The safety triggers to prevent such |
257 | a conversion done to the files in the work tree, but there are a | |
258 | few exceptions. Even though... | |
259 | ||
0b444cdb | 260 | - 'git add' itself does not touch the files in the work tree, the |
21e5ad50 SP |
261 | next checkout would, so the safety triggers; |
262 | ||
0b444cdb | 263 | - 'git apply' to update a text file with a patch does touch the files |
21e5ad50 SP |
264 | in the work tree, but the operation is about text files and CRLF |
265 | conversion is about fixing the line ending inconsistencies, so the | |
266 | safety does not trigger; | |
267 | ||
0b444cdb TR |
268 | - 'git diff' itself does not touch the files in the work tree, it is |
269 | often run to inspect the changes you intend to next 'git add'. To | |
21e5ad50 SP |
270 | catch potential problems early, safety triggers. |
271 | ||
88e7fdf2 | 272 | |
3fed15f5 JH |
273 | `ident` |
274 | ^^^^^^^ | |
275 | ||
2de9b711 | 276 | When the attribute `ident` is set for a path, Git replaces |
2c850f12 | 277 | `$Id$` in the blob object with `$Id:`, followed by the |
3fed15f5 JH |
278 | 40-character hexadecimal blob object name, followed by a dollar |
279 | sign `$` upon checkout. Any byte sequence that begins with | |
af9b54bb AP |
280 | `$Id:` and ends with `$` in the worktree file is replaced |
281 | with `$Id$` upon check-in. | |
3fed15f5 JH |
282 | |
283 | ||
aa4ed402 JH |
284 | `filter` |
285 | ^^^^^^^^ | |
286 | ||
c05ef938 | 287 | A `filter` attribute can be set to a string value that names a |
aa4ed402 JH |
288 | filter driver specified in the configuration. |
289 | ||
c05ef938 | 290 | A filter driver consists of a `clean` command and a `smudge` |
aa4ed402 | 291 | command, either of which can be left unspecified. Upon |
c05ef938 WC |
292 | checkout, when the `smudge` command is specified, the command is |
293 | fed the blob object from its standard input, and its standard | |
294 | output is used to update the worktree file. Similarly, the | |
295 | `clean` command is used to convert the contents of worktree file | |
edcc8581 LS |
296 | upon checkin. By default these commands process only a single |
297 | blob and terminate. If a long running `process` filter is used | |
298 | in place of `clean` and/or `smudge` filters, then Git can process | |
299 | all blobs with a single filter command invocation for the entire | |
300 | life of a single Git command, for example `git add --all`. If a | |
301 | long running `process` filter is configured then it always takes | |
302 | precedence over a configured single blob filter. See section | |
303 | below for the description of the protocol used to communicate with | |
304 | a `process` filter. | |
aa4ed402 | 305 | |
36daaaca JB |
306 | One use of the content filtering is to massage the content into a shape |
307 | that is more convenient for the platform, filesystem, and the user to use. | |
308 | For this mode of operation, the key phrase here is "more convenient" and | |
309 | not "turning something unusable into usable". In other words, the intent | |
310 | is that if someone unsets the filter driver definition, or does not have | |
311 | the appropriate filter program, the project should still be usable. | |
312 | ||
313 | Another use of the content filtering is to store the content that cannot | |
314 | be directly used in the repository (e.g. a UUID that refers to the true | |
2de9b711 | 315 | content stored outside Git, or an encrypted content) and turn it into a |
36daaaca JB |
316 | usable form upon checkout (e.g. download the external content, or decrypt |
317 | the encrypted content). | |
318 | ||
319 | These two filters behave differently, and by default, a filter is taken as | |
320 | the former, massaging the contents into more convenient shape. A missing | |
321 | filter driver definition in the config, or a filter driver that exits with | |
322 | a non-zero status, is not an error but makes the filter a no-op passthru. | |
323 | ||
324 | You can declare that a filter turns a content that by itself is unusable | |
325 | into a usable content by setting the filter.<driver>.required configuration | |
326 | variable to `true`. | |
aa4ed402 | 327 | |
d79f5d17 NS |
328 | For example, in .gitattributes, you would assign the `filter` |
329 | attribute for paths. | |
330 | ||
331 | ------------------------ | |
332 | *.c filter=indent | |
333 | ------------------------ | |
334 | ||
335 | Then you would define a "filter.indent.clean" and "filter.indent.smudge" | |
336 | configuration in your .git/config to specify a pair of commands to | |
337 | modify the contents of C programs when the source files are checked | |
338 | in ("clean" is run) and checked out (no change is made because the | |
339 | command is "cat"). | |
340 | ||
341 | ------------------------ | |
342 | [filter "indent"] | |
343 | clean = indent | |
344 | smudge = cat | |
345 | ------------------------ | |
346 | ||
f217f0e8 EB |
347 | For best results, `clean` should not alter its output further if it is |
348 | run twice ("clean->clean" should be equivalent to "clean"), and | |
349 | multiple `smudge` commands should not alter `clean`'s output | |
350 | ("smudge->smudge->clean" should be equivalent to "clean"). See the | |
351 | section on merging below. | |
352 | ||
353 | The "indent" filter is well-behaved in this regard: it will not modify | |
354 | input that is already correctly indented. In this case, the lack of a | |
355 | smudge filter means that the clean filter _must_ accept its own output | |
356 | without modifying it. | |
357 | ||
36daaaca JB |
358 | If a filter _must_ succeed in order to make the stored contents usable, |
359 | you can declare that the filter is `required`, in the configuration: | |
360 | ||
361 | ------------------------ | |
362 | [filter "crypt"] | |
363 | clean = openssl enc ... | |
364 | smudge = openssl enc -d ... | |
365 | required | |
366 | ------------------------ | |
367 | ||
a2b665de PW |
368 | Sequence "%f" on the filter command line is replaced with the name of |
369 | the file the filter is working on. A filter might use this in keyword | |
370 | substitution. For example: | |
371 | ||
372 | ------------------------ | |
373 | [filter "p4"] | |
374 | clean = git-p4-filter --clean %f | |
375 | smudge = git-p4-filter --smudge %f | |
376 | ------------------------ | |
377 | ||
52db4b04 JH |
378 | Note that "%f" is the name of the path that is being worked on. Depending |
379 | on the version that is being filtered, the corresponding file on disk may | |
380 | not exist, or may have different contents. So, smudge and clean commands | |
381 | should not try to access the file on disk, but only act as filters on the | |
382 | content provided to them on standard input. | |
aa4ed402 | 383 | |
edcc8581 LS |
384 | Long Running Filter Process |
385 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
386 | ||
387 | If the filter command (a string value) is defined via | |
388 | `filter.<driver>.process` then Git can process all blobs with a | |
389 | single filter invocation for the entire life of a single Git | |
390 | command. This is achieved by using a packet format (pkt-line, | |
391 | see technical/protocol-common.txt) based protocol over standard | |
392 | input and standard output as follows. All packets, except for the | |
393 | "*CONTENT" packets and the "0000" flush packet, are considered | |
394 | text and therefore are terminated by a LF. | |
395 | ||
396 | Git starts the filter when it encounters the first file | |
397 | that needs to be cleaned or smudged. After the filter started | |
398 | Git sends a welcome message ("git-filter-client"), a list of supported | |
399 | protocol version numbers, and a flush packet. Git expects to read a welcome | |
400 | response message ("git-filter-server"), exactly one protocol version number | |
401 | from the previously sent list, and a flush packet. All further | |
402 | communication will be based on the selected version. The remaining | |
403 | protocol description below documents "version=2". Please note that | |
404 | "version=42" in the example below does not exist and is only there | |
405 | to illustrate how the protocol would look like with more than one | |
406 | version. | |
407 | ||
408 | After the version negotiation Git sends a list of all capabilities that | |
409 | it supports and a flush packet. Git expects to read a list of desired | |
410 | capabilities, which must be a subset of the supported capabilities list, | |
411 | and a flush packet as response: | |
412 | ------------------------ | |
413 | packet: git> git-filter-client | |
414 | packet: git> version=2 | |
415 | packet: git> version=42 | |
416 | packet: git> 0000 | |
417 | packet: git< git-filter-server | |
418 | packet: git< version=2 | |
419 | packet: git< 0000 | |
420 | packet: git> capability=clean | |
421 | packet: git> capability=smudge | |
422 | packet: git> capability=not-yet-invented | |
423 | packet: git> 0000 | |
424 | packet: git< capability=clean | |
425 | packet: git< capability=smudge | |
426 | packet: git< 0000 | |
427 | ------------------------ | |
428 | Supported filter capabilities in version 2 are "clean" and | |
429 | "smudge". | |
430 | ||
431 | Afterwards Git sends a list of "key=value" pairs terminated with | |
432 | a flush packet. The list will contain at least the filter command | |
433 | (based on the supported capabilities) and the pathname of the file | |
434 | to filter relative to the repository root. Right after the flush packet | |
435 | Git sends the content split in zero or more pkt-line packets and a | |
436 | flush packet to terminate content. Please note, that the filter | |
437 | must not send any response before it received the content and the | |
c6b0831c LS |
438 | final flush packet. Also note that the "value" of a "key=value" pair |
439 | can contain the "=" character whereas the key would never contain | |
440 | that character. | |
edcc8581 LS |
441 | ------------------------ |
442 | packet: git> command=smudge | |
443 | packet: git> pathname=path/testfile.dat | |
444 | packet: git> 0000 | |
445 | packet: git> CONTENT | |
446 | packet: git> 0000 | |
447 | ------------------------ | |
448 | ||
449 | The filter is expected to respond with a list of "key=value" pairs | |
450 | terminated with a flush packet. If the filter does not experience | |
451 | problems then the list must contain a "success" status. Right after | |
452 | these packets the filter is expected to send the content in zero | |
453 | or more pkt-line packets and a flush packet at the end. Finally, a | |
454 | second list of "key=value" pairs terminated with a flush packet | |
455 | is expected. The filter can change the status in the second list | |
456 | or keep the status as is with an empty list. Please note that the | |
457 | empty list must be terminated with a flush packet regardless. | |
458 | ||
459 | ------------------------ | |
460 | packet: git< status=success | |
461 | packet: git< 0000 | |
462 | packet: git< SMUDGED_CONTENT | |
463 | packet: git< 0000 | |
464 | packet: git< 0000 # empty list, keep "status=success" unchanged! | |
465 | ------------------------ | |
466 | ||
467 | If the result content is empty then the filter is expected to respond | |
468 | with a "success" status and a flush packet to signal the empty content. | |
469 | ------------------------ | |
470 | packet: git< status=success | |
471 | packet: git< 0000 | |
472 | packet: git< 0000 # empty content! | |
473 | packet: git< 0000 # empty list, keep "status=success" unchanged! | |
474 | ------------------------ | |
475 | ||
476 | In case the filter cannot or does not want to process the content, | |
477 | it is expected to respond with an "error" status. | |
478 | ------------------------ | |
479 | packet: git< status=error | |
480 | packet: git< 0000 | |
481 | ------------------------ | |
482 | ||
483 | If the filter experiences an error during processing, then it can | |
484 | send the status "error" after the content was (partially or | |
485 | completely) sent. | |
486 | ------------------------ | |
487 | packet: git< status=success | |
488 | packet: git< 0000 | |
489 | packet: git< HALF_WRITTEN_ERRONEOUS_CONTENT | |
490 | packet: git< 0000 | |
491 | packet: git< status=error | |
492 | packet: git< 0000 | |
493 | ------------------------ | |
494 | ||
495 | In case the filter cannot or does not want to process the content | |
496 | as well as any future content for the lifetime of the Git process, | |
497 | then it is expected to respond with an "abort" status at any point | |
498 | in the protocol. | |
499 | ------------------------ | |
500 | packet: git< status=abort | |
501 | packet: git< 0000 | |
502 | ------------------------ | |
503 | ||
504 | Git neither stops nor restarts the filter process in case the | |
505 | "error"/"abort" status is set. However, Git sets its exit code | |
506 | according to the `filter.<driver>.required` flag, mimicking the | |
507 | behavior of the `filter.<driver>.clean` / `filter.<driver>.smudge` | |
508 | mechanism. | |
509 | ||
510 | If the filter dies during the communication or does not adhere to | |
511 | the protocol then Git will stop the filter process and restart it | |
512 | with the next file that needs to be processed. Depending on the | |
513 | `filter.<driver>.required` flag Git will interpret that as error. | |
514 | ||
515 | After the filter has processed a blob it is expected to wait for | |
516 | the next "key=value" list containing a command. Git will close | |
517 | the command pipe on exit. The filter is expected to detect EOF | |
518 | and exit gracefully on its own. Git will wait until the filter | |
519 | process has stopped. | |
520 | ||
0f71fa27 LS |
521 | A long running filter demo implementation can be found in |
522 | `contrib/long-running-filter/example.pl` located in the Git | |
523 | core repository. If you develop your own long running filter | |
edcc8581 LS |
524 | process then the `GIT_TRACE_PACKET` environment variables can be |
525 | very helpful for debugging (see linkgit:git[1]). | |
526 | ||
527 | Please note that you cannot use an existing `filter.<driver>.clean` | |
528 | or `filter.<driver>.smudge` command with `filter.<driver>.process` | |
529 | because the former two use a different inter process communication | |
530 | protocol than the latter one. | |
531 | ||
532 | ||
aa4ed402 JH |
533 | Interaction between checkin/checkout attributes |
534 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
535 | ||
536 | In the check-in codepath, the worktree file is first converted | |
537 | with `filter` driver (if specified and corresponding driver | |
538 | defined), then the result is processed with `ident` (if | |
5ec3e670 | 539 | specified), and then finally with `text` (again, if specified |
aa4ed402 JH |
540 | and applicable). |
541 | ||
542 | In the check-out codepath, the blob content is first converted | |
5ec3e670 | 543 | with `text`, and then `ident` and fed to `filter`. |
aa4ed402 JH |
544 | |
545 | ||
f217f0e8 EB |
546 | Merging branches with differing checkin/checkout attributes |
547 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
548 | ||
549 | If you have added attributes to a file that cause the canonical | |
550 | repository format for that file to change, such as adding a | |
551 | clean/smudge filter or text/eol/ident attributes, merging anything | |
552 | where the attribute is not in place would normally cause merge | |
553 | conflicts. | |
554 | ||
2de9b711 | 555 | To prevent these unnecessary merge conflicts, Git can be told to run a |
f217f0e8 EB |
556 | virtual check-out and check-in of all three stages of a file when |
557 | resolving a three-way merge by setting the `merge.renormalize` | |
558 | configuration variable. This prevents changes caused by check-in | |
559 | conversion from causing spurious merge conflicts when a converted file | |
560 | is merged with an unconverted file. | |
561 | ||
562 | As long as a "smudge->clean" results in the same output as a "clean" | |
563 | even on files that are already smudged, this strategy will | |
564 | automatically resolve all filter-related conflicts. Filters that do | |
565 | not act in this way may cause additional merge conflicts that must be | |
566 | resolved manually. | |
567 | ||
568 | ||
88e7fdf2 JH |
569 | Generating diff text |
570 | ~~~~~~~~~~~~~~~~~~~~ | |
571 | ||
4f73e240 JN |
572 | `diff` |
573 | ^^^^^^ | |
574 | ||
2de9b711 TA |
575 | The attribute `diff` affects how Git generates diffs for particular |
576 | files. It can tell Git whether to generate a textual patch for the path | |
678852d9 | 577 | or to treat the path as a binary file. It can also affect what line is |
2de9b711 TA |
578 | shown on the hunk header `@@ -k,l +n,m @@` line, tell Git to use an |
579 | external command to generate the diff, or ask Git to convert binary | |
678852d9 | 580 | files to a text format before generating the diff. |
88e7fdf2 JH |
581 | |
582 | Set:: | |
583 | ||
584 | A path to which the `diff` attribute is set is treated | |
585 | as text, even when they contain byte values that | |
586 | normally never appear in text files, such as NUL. | |
587 | ||
588 | Unset:: | |
589 | ||
590 | A path to which the `diff` attribute is unset will | |
678852d9 JK |
591 | generate `Binary files differ` (or a binary patch, if |
592 | binary patches are enabled). | |
88e7fdf2 JH |
593 | |
594 | Unspecified:: | |
595 | ||
596 | A path to which the `diff` attribute is unspecified | |
597 | first gets its contents inspected, and if it looks like | |
6bf3b813 NTND |
598 | text and is smaller than core.bigFileThreshold, it is treated |
599 | as text. Otherwise it would generate `Binary files differ`. | |
88e7fdf2 | 600 | |
2cc3167c JH |
601 | String:: |
602 | ||
678852d9 JK |
603 | Diff is shown using the specified diff driver. Each driver may |
604 | specify one or more options, as described in the following | |
605 | section. The options for the diff driver "foo" are defined | |
606 | by the configuration variables in the "diff.foo" section of the | |
2de9b711 | 607 | Git config file. |
2cc3167c JH |
608 | |
609 | ||
678852d9 JK |
610 | Defining an external diff driver |
611 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
2cc3167c JH |
612 | |
613 | The definition of a diff driver is done in `gitconfig`, not | |
614 | `gitattributes` file, so strictly speaking this manual page is a | |
615 | wrong place to talk about it. However... | |
616 | ||
678852d9 | 617 | To define an external diff driver `jcdiff`, add a section to your |
2cc3167c JH |
618 | `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this: |
619 | ||
620 | ---------------------------------------------------------------- | |
621 | [diff "jcdiff"] | |
622 | command = j-c-diff | |
623 | ---------------------------------------------------------------- | |
624 | ||
2de9b711 | 625 | When Git needs to show you a diff for the path with `diff` |
2cc3167c JH |
626 | attribute set to `jcdiff`, it calls the command you specified |
627 | with the above configuration, i.e. `j-c-diff`, with 7 | |
628 | parameters, just like `GIT_EXTERNAL_DIFF` program is called. | |
9e1f0a85 | 629 | See linkgit:git[1] for details. |
88e7fdf2 JH |
630 | |
631 | ||
ae7aa499 JH |
632 | Defining a custom hunk-header |
633 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
634 | ||
c882c01e | 635 | Each group of changes (called a "hunk") in the textual diff output |
ae7aa499 JH |
636 | is prefixed with a line of the form: |
637 | ||
638 | @@ -k,l +n,m @@ TEXT | |
639 | ||
c882c01e GD |
640 | This is called a 'hunk header'. The "TEXT" portion is by default a line |
641 | that begins with an alphabet, an underscore or a dollar sign; this | |
642 | matches what GNU 'diff -p' output uses. This default selection however | |
643 | is not suited for some contents, and you can use a customized pattern | |
644 | to make a selection. | |
ae7aa499 | 645 | |
c882c01e | 646 | First, in .gitattributes, you would assign the `diff` attribute |
ae7aa499 JH |
647 | for paths. |
648 | ||
649 | ------------------------ | |
650 | *.tex diff=tex | |
651 | ------------------------ | |
652 | ||
edb7e82f | 653 | Then, you would define a "diff.tex.xfuncname" configuration to |
ae7aa499 | 654 | specify a regular expression that matches a line that you would |
c4c86d23 JK |
655 | want to appear as the hunk header "TEXT". Add a section to your |
656 | `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this: | |
ae7aa499 JH |
657 | |
658 | ------------------------ | |
659 | [diff "tex"] | |
45d9414f | 660 | xfuncname = "^(\\\\(sub)*section\\{.*)$" |
ae7aa499 JH |
661 | ------------------------ |
662 | ||
663 | Note. A single level of backslashes are eaten by the | |
664 | configuration file parser, so you would need to double the | |
665 | backslashes; the pattern above picks a line that begins with a | |
02783075 | 666 | backslash, and zero or more occurrences of `sub` followed by |
ae7aa499 JH |
667 | `section` followed by open brace, to the end of line. |
668 | ||
669 | There are a few built-in patterns to make this easier, and `tex` | |
670 | is one of them, so you do not have to write the above in your | |
671 | configuration file (you still need to enable this with the | |
d08ed6d6 GH |
672 | attribute mechanism, via `.gitattributes`). The following built in |
673 | patterns are available: | |
674 | ||
e90d065e AJ |
675 | - `ada` suitable for source code in the Ada language. |
676 | ||
23b5beb2 GH |
677 | - `bibtex` suitable for files with BibTeX coded references. |
678 | ||
80c49c3d TR |
679 | - `cpp` suitable for source code in the C and C++ languages. |
680 | ||
b221207d PO |
681 | - `csharp` suitable for source code in the C# language. |
682 | ||
0719f3ee WD |
683 | - `css` suitable for cascading style sheets. |
684 | ||
909a5494 BC |
685 | - `fortran` suitable for source code in the Fortran language. |
686 | ||
69f9c87d ZB |
687 | - `fountain` suitable for Fountain documents. |
688 | ||
af9ce1ff AE |
689 | - `html` suitable for HTML/XHTML documents. |
690 | ||
b66e00f1 | 691 | - `java` suitable for source code in the Java language. |
d08ed6d6 | 692 | |
53b10a14 GH |
693 | - `matlab` suitable for source code in the MATLAB language. |
694 | ||
5d1e958e JS |
695 | - `objc` suitable for source code in the Objective-C language. |
696 | ||
d08ed6d6 GH |
697 | - `pascal` suitable for source code in the Pascal/Delphi language. |
698 | ||
71a5d4bc JN |
699 | - `perl` suitable for source code in the Perl language. |
700 | ||
af9ce1ff AE |
701 | - `php` suitable for source code in the PHP language. |
702 | ||
7c17205b KS |
703 | - `python` suitable for source code in the Python language. |
704 | ||
d08ed6d6 GH |
705 | - `ruby` suitable for source code in the Ruby language. |
706 | ||
707 | - `tex` suitable for source code for LaTeX documents. | |
ae7aa499 JH |
708 | |
709 | ||
80c49c3d TR |
710 | Customizing word diff |
711 | ^^^^^^^^^^^^^^^^^^^^^ | |
712 | ||
882749a0 | 713 | You can customize the rules that `git diff --word-diff` uses to |
80c49c3d | 714 | split words in a line, by specifying an appropriate regular expression |
ae3b970a | 715 | in the "diff.*.wordRegex" configuration variable. For example, in TeX |
80c49c3d TR |
716 | a backslash followed by a sequence of letters forms a command, but |
717 | several such commands can be run together without intervening | |
c4c86d23 JK |
718 | whitespace. To separate them, use a regular expression in your |
719 | `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this: | |
80c49c3d TR |
720 | |
721 | ------------------------ | |
722 | [diff "tex"] | |
ae3b970a | 723 | wordRegex = "\\\\[a-zA-Z]+|[{}]|\\\\.|[^\\{}[:space:]]+" |
80c49c3d TR |
724 | ------------------------ |
725 | ||
726 | A built-in pattern is provided for all languages listed in the | |
727 | previous section. | |
728 | ||
729 | ||
678852d9 JK |
730 | Performing text diffs of binary files |
731 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
732 | ||
733 | Sometimes it is desirable to see the diff of a text-converted | |
734 | version of some binary files. For example, a word processor | |
735 | document can be converted to an ASCII text representation, and | |
736 | the diff of the text shown. Even though this conversion loses | |
737 | some information, the resulting diff is useful for human | |
738 | viewing (but cannot be applied directly). | |
739 | ||
740 | The `textconv` config option is used to define a program for | |
741 | performing such a conversion. The program should take a single | |
742 | argument, the name of a file to convert, and produce the | |
743 | resulting text on stdout. | |
744 | ||
745 | For example, to show the diff of the exif information of a | |
746 | file instead of the binary information (assuming you have the | |
c4c86d23 JK |
747 | exif tool installed), add the following section to your |
748 | `$GIT_DIR/config` file (or `$HOME/.gitconfig` file): | |
678852d9 JK |
749 | |
750 | ------------------------ | |
751 | [diff "jpg"] | |
752 | textconv = exif | |
753 | ------------------------ | |
754 | ||
755 | NOTE: The text conversion is generally a one-way conversion; | |
756 | in this example, we lose the actual image contents and focus | |
757 | just on the text data. This means that diffs generated by | |
758 | textconv are _not_ suitable for applying. For this reason, | |
759 | only `git diff` and the `git log` family of commands (i.e., | |
760 | log, whatchanged, show) will perform text conversion. `git | |
761 | format-patch` will never generate this output. If you want to | |
762 | send somebody a text-converted diff of a binary file (e.g., | |
763 | because it quickly conveys the changes you have made), you | |
764 | should generate it separately and send it as a comment _in | |
765 | addition to_ the usual binary diff that you might send. | |
766 | ||
d9bae1a1 | 767 | Because text conversion can be slow, especially when doing a |
2de9b711 | 768 | large number of them with `git log -p`, Git provides a mechanism |
d9bae1a1 JK |
769 | to cache the output and use it in future diffs. To enable |
770 | caching, set the "cachetextconv" variable in your diff driver's | |
771 | config. For example: | |
772 | ||
773 | ------------------------ | |
774 | [diff "jpg"] | |
775 | textconv = exif | |
776 | cachetextconv = true | |
777 | ------------------------ | |
778 | ||
779 | This will cache the result of running "exif" on each blob | |
780 | indefinitely. If you change the textconv config variable for a | |
2de9b711 | 781 | diff driver, Git will automatically invalidate the cache entries |
d9bae1a1 JK |
782 | and re-run the textconv filter. If you want to invalidate the |
783 | cache manually (e.g., because your version of "exif" was updated | |
784 | and now produces better output), you can remove the cache | |
785 | manually with `git update-ref -d refs/notes/textconv/jpg` (where | |
786 | "jpg" is the name of the diff driver, as in the example above). | |
678852d9 | 787 | |
55601c6a JK |
788 | Choosing textconv versus external diff |
789 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
790 | ||
791 | If you want to show differences between binary or specially-formatted | |
792 | blobs in your repository, you can choose to use either an external diff | |
793 | command, or to use textconv to convert them to a diff-able text format. | |
794 | Which method you choose depends on your exact situation. | |
795 | ||
796 | The advantage of using an external diff command is flexibility. You are | |
797 | not bound to find line-oriented changes, nor is it necessary for the | |
798 | output to resemble unified diff. You are free to locate and report | |
799 | changes in the most appropriate way for your data format. | |
800 | ||
801 | A textconv, by comparison, is much more limiting. You provide a | |
2de9b711 | 802 | transformation of the data into a line-oriented text format, and Git |
55601c6a JK |
803 | uses its regular diff tools to generate the output. There are several |
804 | advantages to choosing this method: | |
805 | ||
806 | 1. Ease of use. It is often much simpler to write a binary to text | |
807 | transformation than it is to perform your own diff. In many cases, | |
808 | existing programs can be used as textconv filters (e.g., exif, | |
809 | odt2txt). | |
810 | ||
811 | 2. Git diff features. By performing only the transformation step | |
2de9b711 | 812 | yourself, you can still utilize many of Git's diff features, |
55601c6a JK |
813 | including colorization, word-diff, and combined diffs for merges. |
814 | ||
815 | 3. Caching. Textconv caching can speed up repeated diffs, such as those | |
816 | you might trigger by running `git log -p`. | |
817 | ||
818 | ||
ab435611 JK |
819 | Marking files as binary |
820 | ^^^^^^^^^^^^^^^^^^^^^^^ | |
821 | ||
822 | Git usually guesses correctly whether a blob contains text or binary | |
823 | data by examining the beginning of the contents. However, sometimes you | |
824 | may want to override its decision, either because a blob contains binary | |
825 | data later in the file, or because the content, while technically | |
826 | composed of text characters, is opaque to a human reader. For example, | |
f745acb0 | 827 | many postscript files contain only ASCII characters, but produce noisy |
ab435611 JK |
828 | and meaningless diffs. |
829 | ||
830 | The simplest way to mark a file as binary is to unset the diff | |
831 | attribute in the `.gitattributes` file: | |
832 | ||
833 | ------------------------ | |
834 | *.ps -diff | |
835 | ------------------------ | |
836 | ||
2de9b711 | 837 | This will cause Git to generate `Binary files differ` (or a binary |
ab435611 JK |
838 | patch, if binary patches are enabled) instead of a regular diff. |
839 | ||
840 | However, one may also want to specify other diff driver attributes. For | |
841 | example, you might want to use `textconv` to convert postscript files to | |
f745acb0 | 842 | an ASCII representation for human viewing, but otherwise treat them as |
ab435611 JK |
843 | binary files. You cannot specify both `-diff` and `diff=ps` attributes. |
844 | The solution is to use the `diff.*.binary` config option: | |
845 | ||
846 | ------------------------ | |
847 | [diff "ps"] | |
848 | textconv = ps2ascii | |
849 | binary = true | |
850 | ------------------------ | |
851 | ||
88e7fdf2 JH |
852 | Performing a three-way merge |
853 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
854 | ||
4f73e240 JN |
855 | `merge` |
856 | ^^^^^^^ | |
857 | ||
b547ce0b | 858 | The attribute `merge` affects how three versions of a file are |
88e7fdf2 | 859 | merged when a file-level merge is necessary during `git merge`, |
57f6ec02 | 860 | and other commands such as `git revert` and `git cherry-pick`. |
88e7fdf2 JH |
861 | |
862 | Set:: | |
863 | ||
864 | Built-in 3-way merge driver is used to merge the | |
2fd02c92 | 865 | contents in a way similar to 'merge' command of `RCS` |
88e7fdf2 JH |
866 | suite. This is suitable for ordinary text files. |
867 | ||
868 | Unset:: | |
869 | ||
870 | Take the version from the current branch as the | |
871 | tentative merge result, and declare that the merge has | |
b547ce0b | 872 | conflicts. This is suitable for binary files that do |
88e7fdf2 JH |
873 | not have a well-defined merge semantics. |
874 | ||
875 | Unspecified:: | |
876 | ||
877 | By default, this uses the same built-in 3-way merge | |
b547ce0b AS |
878 | driver as is the case when the `merge` attribute is set. |
879 | However, the `merge.default` configuration variable can name | |
880 | different merge driver to be used with paths for which the | |
88e7fdf2 JH |
881 | `merge` attribute is unspecified. |
882 | ||
2cc3167c | 883 | String:: |
88e7fdf2 JH |
884 | |
885 | 3-way merge is performed using the specified custom | |
886 | merge driver. The built-in 3-way merge driver can be | |
887 | explicitly specified by asking for "text" driver; the | |
888 | built-in "take the current branch" driver can be | |
b9d14ffb | 889 | requested with "binary". |
88e7fdf2 JH |
890 | |
891 | ||
0e545f75 JH |
892 | Built-in merge drivers |
893 | ^^^^^^^^^^^^^^^^^^^^^^ | |
894 | ||
895 | There are a few built-in low-level merge drivers defined that | |
896 | can be asked for via the `merge` attribute. | |
897 | ||
898 | text:: | |
899 | ||
900 | Usual 3-way file level merge for text files. Conflicted | |
901 | regions are marked with conflict markers `<<<<<<<`, | |
902 | `=======` and `>>>>>>>`. The version from your branch | |
903 | appears before the `=======` marker, and the version | |
904 | from the merged branch appears after the `=======` | |
905 | marker. | |
906 | ||
907 | binary:: | |
908 | ||
909 | Keep the version from your branch in the work tree, but | |
910 | leave the path in the conflicted state for the user to | |
911 | sort out. | |
912 | ||
913 | union:: | |
914 | ||
915 | Run 3-way file level merge for text files, but take | |
916 | lines from both versions, instead of leaving conflict | |
917 | markers. This tends to leave the added lines in the | |
918 | resulting file in random order and the user should | |
919 | verify the result. Do not use this if you do not | |
920 | understand the implications. | |
921 | ||
922 | ||
88e7fdf2 JH |
923 | Defining a custom merge driver |
924 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
925 | ||
0e545f75 JH |
926 | The definition of a merge driver is done in the `.git/config` |
927 | file, not in the `gitattributes` file, so strictly speaking this | |
928 | manual page is a wrong place to talk about it. However... | |
88e7fdf2 JH |
929 | |
930 | To define a custom merge driver `filfre`, add a section to your | |
931 | `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this: | |
932 | ||
933 | ---------------------------------------------------------------- | |
934 | [merge "filfre"] | |
935 | name = feel-free merge driver | |
ef45bb1f | 936 | driver = filfre %O %A %B %L %P |
88e7fdf2 JH |
937 | recursive = binary |
938 | ---------------------------------------------------------------- | |
939 | ||
940 | The `merge.*.name` variable gives the driver a human-readable | |
941 | name. | |
942 | ||
943 | The `merge.*.driver` variable's value is used to construct a | |
944 | command to run to merge ancestor's version (`%O`), current | |
945 | version (`%A`) and the other branches' version (`%B`). These | |
946 | three tokens are replaced with the names of temporary files that | |
947 | hold the contents of these versions when the command line is | |
16758621 BW |
948 | built. Additionally, %L will be replaced with the conflict marker |
949 | size (see below). | |
88e7fdf2 JH |
950 | |
951 | The merge driver is expected to leave the result of the merge in | |
952 | the file named with `%A` by overwriting it, and exit with zero | |
953 | status if it managed to merge them cleanly, or non-zero if there | |
954 | were conflicts. | |
955 | ||
956 | The `merge.*.recursive` variable specifies what other merge | |
957 | driver to use when the merge driver is called for an internal | |
958 | merge between common ancestors, when there are more than one. | |
959 | When left unspecified, the driver itself is used for both | |
960 | internal merge and the final merge. | |
961 | ||
ef45bb1f JH |
962 | The merge driver can learn the pathname in which the merged result |
963 | will be stored via placeholder `%P`. | |
964 | ||
88e7fdf2 | 965 | |
4c734803 JH |
966 | `conflict-marker-size` |
967 | ^^^^^^^^^^^^^^^^^^^^^^ | |
968 | ||
969 | This attribute controls the length of conflict markers left in | |
970 | the work tree file during a conflicted merge. Only setting to | |
971 | the value to a positive integer has any meaningful effect. | |
972 | ||
973 | For example, this line in `.gitattributes` can be used to tell the merge | |
974 | machinery to leave much longer (instead of the usual 7-character-long) | |
975 | conflict markers when merging the file `Documentation/git-merge.txt` | |
976 | results in a conflict. | |
977 | ||
978 | ------------------------ | |
979 | Documentation/git-merge.txt conflict-marker-size=32 | |
980 | ------------------------ | |
981 | ||
982 | ||
cf1b7869 JH |
983 | Checking whitespace errors |
984 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
985 | ||
986 | `whitespace` | |
987 | ^^^^^^^^^^^^ | |
988 | ||
989 | The `core.whitespace` configuration variable allows you to define what | |
2fd02c92 | 990 | 'diff' and 'apply' should consider whitespace errors for all paths in |
5162e697 | 991 | the project (See linkgit:git-config[1]). This attribute gives you finer |
cf1b7869 JH |
992 | control per path. |
993 | ||
994 | Set:: | |
995 | ||
2de9b711 | 996 | Notice all types of potential whitespace errors known to Git. |
f4b05a49 JS |
997 | The tab width is taken from the value of the `core.whitespace` |
998 | configuration variable. | |
cf1b7869 JH |
999 | |
1000 | Unset:: | |
1001 | ||
1002 | Do not notice anything as error. | |
1003 | ||
1004 | Unspecified:: | |
1005 | ||
f4b05a49 | 1006 | Use the value of the `core.whitespace` configuration variable to |
cf1b7869 JH |
1007 | decide what to notice as error. |
1008 | ||
1009 | String:: | |
1010 | ||
1011 | Specify a comma separate list of common whitespace problems to | |
f4b05a49 | 1012 | notice in the same format as the `core.whitespace` configuration |
cf1b7869 JH |
1013 | variable. |
1014 | ||
1015 | ||
8a33dd8b JH |
1016 | Creating an archive |
1017 | ~~~~~~~~~~~~~~~~~~~ | |
1018 | ||
08b51f51 JH |
1019 | `export-ignore` |
1020 | ^^^^^^^^^^^^^^^ | |
1021 | ||
1022 | Files and directories with the attribute `export-ignore` won't be added to | |
1023 | archive files. | |
1024 | ||
8a33dd8b JH |
1025 | `export-subst` |
1026 | ^^^^^^^^^^^^^^ | |
1027 | ||
2de9b711 | 1028 | If the attribute `export-subst` is set for a file then Git will expand |
8a33dd8b | 1029 | several placeholders when adding this file to an archive. The |
08b51f51 | 1030 | expansion depends on the availability of a commit ID, i.e., if |
8a33dd8b JH |
1031 | linkgit:git-archive[1] has been given a tree instead of a commit or a |
1032 | tag then no replacement will be done. The placeholders are the same | |
1033 | as those for the option `--pretty=format:` of linkgit:git-log[1], | |
1034 | except that they need to be wrapped like this: `$Format:PLACEHOLDERS$` | |
1035 | in the file. E.g. the string `$Format:%H$` will be replaced by the | |
1036 | commit hash. | |
1037 | ||
1038 | ||
975457f1 NG |
1039 | Packing objects |
1040 | ~~~~~~~~~~~~~~~ | |
1041 | ||
1042 | `delta` | |
1043 | ^^^^^^^ | |
1044 | ||
1045 | Delta compression will not be attempted for blobs for paths with the | |
1046 | attribute `delta` set to false. | |
1047 | ||
1048 | ||
a2df1fb2 AG |
1049 | Viewing files in GUI tools |
1050 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
1051 | ||
1052 | `encoding` | |
1053 | ^^^^^^^^^^ | |
1054 | ||
1055 | The value of this attribute specifies the character encoding that should | |
1056 | be used by GUI tools (e.g. linkgit:gitk[1] and linkgit:git-gui[1]) to | |
1057 | display the contents of the relevant file. Note that due to performance | |
1058 | considerations linkgit:gitk[1] does not use this attribute unless you | |
1059 | manually enable per-file encodings in its options. | |
1060 | ||
1061 | If this attribute is not set or has an invalid value, the value of the | |
1062 | `gui.encoding` configuration variable is used instead | |
1063 | (See linkgit:git-config[1]). | |
1064 | ||
1065 | ||
0922570c | 1066 | USING MACRO ATTRIBUTES |
bbb896d8 JH |
1067 | ---------------------- |
1068 | ||
1069 | You do not want any end-of-line conversions applied to, nor textual diffs | |
1070 | produced for, any binary file you track. You would need to specify e.g. | |
1071 | ||
1072 | ------------ | |
5ec3e670 | 1073 | *.jpg -text -diff |
bbb896d8 JH |
1074 | ------------ |
1075 | ||
1076 | but that may become cumbersome, when you have many attributes. Using | |
0922570c | 1077 | macro attributes, you can define an attribute that, when set, also |
98e84066 | 1078 | sets or unsets a number of other attributes at the same time. The |
0922570c | 1079 | system knows a built-in macro attribute, `binary`: |
bbb896d8 JH |
1080 | |
1081 | ------------ | |
1082 | *.jpg binary | |
1083 | ------------ | |
1084 | ||
98e84066 | 1085 | Setting the "binary" attribute also unsets the "text" and "diff" |
0922570c | 1086 | attributes as above. Note that macro attributes can only be "Set", |
98e84066 MH |
1087 | though setting one might have the effect of setting or unsetting other |
1088 | attributes or even returning other attributes to the "Unspecified" | |
1089 | state. | |
bbb896d8 JH |
1090 | |
1091 | ||
0922570c | 1092 | DEFINING MACRO ATTRIBUTES |
bbb896d8 JH |
1093 | ------------------------- |
1094 | ||
e78e6967 MH |
1095 | Custom macro attributes can be defined only in top-level gitattributes |
1096 | files (`$GIT_DIR/info/attributes`, the `.gitattributes` file at the | |
1097 | top level of the working tree, or the global or system-wide | |
1098 | gitattributes files), not in `.gitattributes` files in working tree | |
1099 | subdirectories. The built-in macro attribute "binary" is equivalent | |
1100 | to: | |
bbb896d8 JH |
1101 | |
1102 | ------------ | |
155a4b71 | 1103 | [attr]binary -diff -merge -text |
bbb896d8 JH |
1104 | ------------ |
1105 | ||
1106 | ||
88e7fdf2 JH |
1107 | EXAMPLE |
1108 | ------- | |
1109 | ||
1110 | If you have these three `gitattributes` file: | |
1111 | ||
1112 | ---------------------------------------------------------------- | |
1113 | (in $GIT_DIR/info/attributes) | |
1114 | ||
1115 | a* foo !bar -baz | |
1116 | ||
1117 | (in .gitattributes) | |
1118 | abc foo bar baz | |
1119 | ||
1120 | (in t/.gitattributes) | |
1121 | ab* merge=filfre | |
1122 | abc -foo -bar | |
1123 | *.c frotz | |
1124 | ---------------------------------------------------------------- | |
1125 | ||
1126 | the attributes given to path `t/abc` are computed as follows: | |
1127 | ||
1128 | 1. By examining `t/.gitattributes` (which is in the same | |
2de9b711 | 1129 | directory as the path in question), Git finds that the first |
88e7fdf2 JH |
1130 | line matches. `merge` attribute is set. It also finds that |
1131 | the second line matches, and attributes `foo` and `bar` | |
1132 | are unset. | |
1133 | ||
1134 | 2. Then it examines `.gitattributes` (which is in the parent | |
1135 | directory), and finds that the first line matches, but | |
1136 | `t/.gitattributes` file already decided how `merge`, `foo` | |
1137 | and `bar` attributes should be given to this path, so it | |
1138 | leaves `foo` and `bar` unset. Attribute `baz` is set. | |
1139 | ||
5c759f96 | 1140 | 3. Finally it examines `$GIT_DIR/info/attributes`. This file |
88e7fdf2 JH |
1141 | is used to override the in-tree settings. The first line is |
1142 | a match, and `foo` is set, `bar` is reverted to unspecified | |
1143 | state, and `baz` is unset. | |
1144 | ||
02783075 | 1145 | As the result, the attributes assignment to `t/abc` becomes: |
88e7fdf2 JH |
1146 | |
1147 | ---------------------------------------------------------------- | |
1148 | foo set to true | |
1149 | bar unspecified | |
1150 | baz set to false | |
1151 | merge set to string value "filfre" | |
1152 | frotz unspecified | |
1153 | ---------------------------------------------------------------- | |
1154 | ||
1155 | ||
cde15181 MH |
1156 | SEE ALSO |
1157 | -------- | |
1158 | linkgit:git-check-attr[1]. | |
8460b2fc | 1159 | |
88e7fdf2 JH |
1160 | GIT |
1161 | --- | |
9e1f0a85 | 1162 | Part of the linkgit:git[1] suite |