]> git.ipfire.org Git - thirdparty/git.git/blob - Documentation/gitattributes.txt
Merge branch 'tr/submodule-relative-scp-url'
[thirdparty/git.git] / Documentation / gitattributes.txt
1 gitattributes(5)
2 ================
3
4 NAME
5 ----
6 gitattributes - defining attributes per path
7
8 SYNOPSIS
9 --------
10 $GIT_DIR/info/attributes, .gitattributes
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 pattern attr1 attr2 ...
22
23 That is, a pattern followed by an attributes list,
24 separated by whitespaces. When the 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 pattern matches the path, and nothing says if
52 the path has or does not have the attribute, the
53 attribute for the path is said to be Unspecified.
54
55 When more than one pattern matches the path, a later line
56 overrides an earlier line. This overriding is done per
57 attribute. The rules how the pattern matches paths are the
58 same as in `.gitignore` files; see linkgit:gitignore[5].
59
60 When deciding what attributes are assigned to a path, git
61 consults `$GIT_DIR/info/attributes` file (which has the highest
62 precedence), `.gitattributes` file in the same directory as the
63 path in question, and its parent directories up to the toplevel of the
64 work tree (the further the directory that contains `.gitattributes`
65 is from the path in question, the lower its precedence). Finally
66 global and system-wide files are considered (they have the lowest
67 precedence).
68
69 If you wish to affect only a single repository (i.e., to assign
70 attributes to files that are particular to
71 one user's workflow for that repository), then
72 attributes should be placed in the `$GIT_DIR/info/attributes` file.
73 Attributes which should be version-controlled and distributed to other
74 repositories (i.e., attributes of interest to all users) should go into
75 `.gitattributes` files. Attributes that should affect all repositories
76 for a single user should be placed in a file specified by the
77 `core.attributesfile` configuration option (see linkgit:git-config[1]).
78 Attributes for all users on a system should be placed in the
79 `$(prefix)/etc/gitattributes` file.
80
81 Sometimes you would need to override an setting of an attribute
82 for a path to `unspecified` state. This can be done by listing
83 the name of the attribute prefixed with an exclamation point `!`.
84
85
86 EFFECTS
87 -------
88
89 Certain operations by git can be influenced by assigning
90 particular attributes to a path. Currently, the following
91 operations are attributes-aware.
92
93 Checking-out and checking-in
94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95
96 These attributes affect how the contents stored in the
97 repository are copied to the working tree files when commands
98 such as 'git checkout' and 'git merge' run. They also affect how
99 git stores the contents you prepare in the working tree in the
100 repository upon 'git add' and 'git commit'.
101
102 `text`
103 ^^^^^^
104
105 This attribute enables and controls end-of-line normalization. When a
106 text file is normalized, its line endings are converted to LF in the
107 repository. To control what line ending style is used in the working
108 directory, use the `eol` attribute for a single file and the
109 `core.eol` configuration variable for all text files.
110
111 Set::
112
113 Setting the `text` attribute on a path enables end-of-line
114 normalization and marks the path as a text file. End-of-line
115 conversion takes place without guessing the content type.
116
117 Unset::
118
119 Unsetting the `text` attribute on a path tells git not to
120 attempt any end-of-line conversion upon checkin or checkout.
121
122 Set to string value "auto"::
123
124 When `text` is set to "auto", the path is marked for automatic
125 end-of-line normalization. If git decides that the content is
126 text, its line endings are normalized to LF on checkin.
127
128 Unspecified::
129
130 If the `text` attribute is unspecified, git uses the
131 `core.autocrlf` configuration variable to determine if the
132 file should be converted.
133
134 Any other value causes git to act as if `text` has been left
135 unspecified.
136
137 `eol`
138 ^^^^^
139
140 This attribute sets a specific line-ending style to be used in the
141 working directory. It enables end-of-line normalization without any
142 content checks, effectively setting the `text` attribute.
143
144 Set to string value "crlf"::
145
146 This setting forces git to normalize line endings for this
147 file on checkin and convert them to CRLF when the file is
148 checked out.
149
150 Set to string value "lf"::
151
152 This setting forces git to normalize line endings to LF on
153 checkin and prevents conversion to CRLF when the file is
154 checked out.
155
156 Backwards compatibility with `crlf` attribute
157 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
158
159 For backwards compatibility, the `crlf` attribute is interpreted as
160 follows:
161
162 ------------------------
163 crlf text
164 -crlf -text
165 crlf=input eol=lf
166 ------------------------
167
168 End-of-line conversion
169 ^^^^^^^^^^^^^^^^^^^^^^
170
171 While git normally leaves file contents alone, it can be configured to
172 normalize line endings to LF in the repository and, optionally, to
173 convert them to CRLF when files are checked out.
174
175 Here is an example that will make git normalize .txt, .vcproj and .sh
176 files, ensure that .vcproj files have CRLF and .sh files have LF in
177 the working directory, and prevent .jpg files from being normalized
178 regardless of their content.
179
180 ------------------------
181 *.txt text
182 *.vcproj eol=crlf
183 *.sh eol=lf
184 *.jpg -text
185 ------------------------
186
187 Other source code management systems normalize all text files in their
188 repositories, and there are two ways to enable similar automatic
189 normalization in git.
190
191 If you simply want to have CRLF line endings in your working directory
192 regardless of the repository you are working with, you can set the
193 config variable "core.autocrlf" without changing any attributes.
194
195 ------------------------
196 [core]
197 autocrlf = true
198 ------------------------
199
200 This does not force normalization of all text files, but does ensure
201 that text files that you introduce to the repository have their line
202 endings normalized to LF when they are added, and that files that are
203 already normalized in the repository stay normalized.
204
205 If you want to interoperate with a source code management system that
206 enforces end-of-line normalization, or you simply want all text files
207 in your repository to be normalized, you should instead set the `text`
208 attribute to "auto" for _all_ files.
209
210 ------------------------
211 * text=auto
212 ------------------------
213
214 This ensures that all files that git considers to be text will have
215 normalized (LF) line endings in the repository. The `core.eol`
216 configuration variable controls which line endings git will use for
217 normalized files in your working directory; the default is to use the
218 native line ending for your platform, or CRLF if `core.autocrlf` is
219 set.
220
221 NOTE: When `text=auto` normalization is enabled in an existing
222 repository, any text files containing CRLFs should be normalized. If
223 they are not they will be normalized the next time someone tries to
224 change them, causing unfortunate misattribution. From a clean working
225 directory:
226
227 -------------------------------------------------
228 $ echo "* text=auto" >>.gitattributes
229 $ rm .git/index # Remove the index to force git to
230 $ git reset # re-scan the working directory
231 $ git status # Show files that will be normalized
232 $ git add -u
233 $ git add .gitattributes
234 $ git commit -m "Introduce end-of-line normalization"
235 -------------------------------------------------
236
237 If any files that should not be normalized show up in 'git status',
238 unset their `text` attribute before running 'git add -u'.
239
240 ------------------------
241 manual.pdf -text
242 ------------------------
243
244 Conversely, text files that git does not detect can have normalization
245 enabled manually.
246
247 ------------------------
248 weirdchars.txt text
249 ------------------------
250
251 If `core.safecrlf` is set to "true" or "warn", git verifies if
252 the conversion is reversible for the current setting of
253 `core.autocrlf`. For "true", git rejects irreversible
254 conversions; for "warn", git only prints a warning but accepts
255 an irreversible conversion. The safety triggers to prevent such
256 a conversion done to the files in the work tree, but there are a
257 few exceptions. Even though...
258
259 - 'git add' itself does not touch the files in the work tree, the
260 next checkout would, so the safety triggers;
261
262 - 'git apply' to update a text file with a patch does touch the files
263 in the work tree, but the operation is about text files and CRLF
264 conversion is about fixing the line ending inconsistencies, so the
265 safety does not trigger;
266
267 - 'git diff' itself does not touch the files in the work tree, it is
268 often run to inspect the changes you intend to next 'git add'. To
269 catch potential problems early, safety triggers.
270
271
272 `ident`
273 ^^^^^^^
274
275 When the attribute `ident` is set for a path, git replaces
276 `$Id$` in the blob object with `$Id:`, followed by the
277 40-character hexadecimal blob object name, followed by a dollar
278 sign `$` upon checkout. Any byte sequence that begins with
279 `$Id:` and ends with `$` in the worktree file is replaced
280 with `$Id$` upon check-in.
281
282
283 `filter`
284 ^^^^^^^^
285
286 A `filter` attribute can be set to a string value that names a
287 filter driver specified in the configuration.
288
289 A filter driver consists of a `clean` command and a `smudge`
290 command, either of which can be left unspecified. Upon
291 checkout, when the `smudge` command is specified, the command is
292 fed the blob object from its standard input, and its standard
293 output is used to update the worktree file. Similarly, the
294 `clean` command is used to convert the contents of worktree file
295 upon checkin.
296
297 A missing filter driver definition in the config is not an error
298 but makes the filter a no-op passthru.
299
300 The content filtering is done to massage the content into a
301 shape that is more convenient for the platform, filesystem, and
302 the user to use. The key phrase here is "more convenient" and not
303 "turning something unusable into usable". In other words, the
304 intent is that if someone unsets the filter driver definition,
305 or does not have the appropriate filter program, the project
306 should still be usable.
307
308 For example, in .gitattributes, you would assign the `filter`
309 attribute for paths.
310
311 ------------------------
312 *.c filter=indent
313 ------------------------
314
315 Then you would define a "filter.indent.clean" and "filter.indent.smudge"
316 configuration in your .git/config to specify a pair of commands to
317 modify the contents of C programs when the source files are checked
318 in ("clean" is run) and checked out (no change is made because the
319 command is "cat").
320
321 ------------------------
322 [filter "indent"]
323 clean = indent
324 smudge = cat
325 ------------------------
326
327 For best results, `clean` should not alter its output further if it is
328 run twice ("clean->clean" should be equivalent to "clean"), and
329 multiple `smudge` commands should not alter `clean`'s output
330 ("smudge->smudge->clean" should be equivalent to "clean"). See the
331 section on merging below.
332
333 The "indent" filter is well-behaved in this regard: it will not modify
334 input that is already correctly indented. In this case, the lack of a
335 smudge filter means that the clean filter _must_ accept its own output
336 without modifying it.
337
338 Sequence "%f" on the filter command line is replaced with the name of
339 the file the filter is working on. A filter might use this in keyword
340 substitution. For example:
341
342 ------------------------
343 [filter "p4"]
344 clean = git-p4-filter --clean %f
345 smudge = git-p4-filter --smudge %f
346 ------------------------
347
348
349 Interaction between checkin/checkout attributes
350 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
351
352 In the check-in codepath, the worktree file is first converted
353 with `filter` driver (if specified and corresponding driver
354 defined), then the result is processed with `ident` (if
355 specified), and then finally with `text` (again, if specified
356 and applicable).
357
358 In the check-out codepath, the blob content is first converted
359 with `text`, and then `ident` and fed to `filter`.
360
361
362 Merging branches with differing checkin/checkout attributes
363 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
364
365 If you have added attributes to a file that cause the canonical
366 repository format for that file to change, such as adding a
367 clean/smudge filter or text/eol/ident attributes, merging anything
368 where the attribute is not in place would normally cause merge
369 conflicts.
370
371 To prevent these unnecessary merge conflicts, git can be told to run a
372 virtual check-out and check-in of all three stages of a file when
373 resolving a three-way merge by setting the `merge.renormalize`
374 configuration variable. This prevents changes caused by check-in
375 conversion from causing spurious merge conflicts when a converted file
376 is merged with an unconverted file.
377
378 As long as a "smudge->clean" results in the same output as a "clean"
379 even on files that are already smudged, this strategy will
380 automatically resolve all filter-related conflicts. Filters that do
381 not act in this way may cause additional merge conflicts that must be
382 resolved manually.
383
384
385 Generating diff text
386 ~~~~~~~~~~~~~~~~~~~~
387
388 `diff`
389 ^^^^^^
390
391 The attribute `diff` affects how 'git' generates diffs for particular
392 files. It can tell git whether to generate a textual patch for the path
393 or to treat the path as a binary file. It can also affect what line is
394 shown on the hunk header `@@ -k,l +n,m @@` line, tell git to use an
395 external command to generate the diff, or ask git to convert binary
396 files to a text format before generating the diff.
397
398 Set::
399
400 A path to which the `diff` attribute is set is treated
401 as text, even when they contain byte values that
402 normally never appear in text files, such as NUL.
403
404 Unset::
405
406 A path to which the `diff` attribute is unset will
407 generate `Binary files differ` (or a binary patch, if
408 binary patches are enabled).
409
410 Unspecified::
411
412 A path to which the `diff` attribute is unspecified
413 first gets its contents inspected, and if it looks like
414 text, it is treated as text. Otherwise it would
415 generate `Binary files differ`.
416
417 String::
418
419 Diff is shown using the specified diff driver. Each driver may
420 specify one or more options, as described in the following
421 section. The options for the diff driver "foo" are defined
422 by the configuration variables in the "diff.foo" section of the
423 git config file.
424
425
426 Defining an external diff driver
427 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
428
429 The definition of a diff driver is done in `gitconfig`, not
430 `gitattributes` file, so strictly speaking this manual page is a
431 wrong place to talk about it. However...
432
433 To define an external diff driver `jcdiff`, add a section to your
434 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
435
436 ----------------------------------------------------------------
437 [diff "jcdiff"]
438 command = j-c-diff
439 ----------------------------------------------------------------
440
441 When git needs to show you a diff for the path with `diff`
442 attribute set to `jcdiff`, it calls the command you specified
443 with the above configuration, i.e. `j-c-diff`, with 7
444 parameters, just like `GIT_EXTERNAL_DIFF` program is called.
445 See linkgit:git[1] for details.
446
447
448 Defining a custom hunk-header
449 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
450
451 Each group of changes (called a "hunk") in the textual diff output
452 is prefixed with a line of the form:
453
454 @@ -k,l +n,m @@ TEXT
455
456 This is called a 'hunk header'. The "TEXT" portion is by default a line
457 that begins with an alphabet, an underscore or a dollar sign; this
458 matches what GNU 'diff -p' output uses. This default selection however
459 is not suited for some contents, and you can use a customized pattern
460 to make a selection.
461
462 First, in .gitattributes, you would assign the `diff` attribute
463 for paths.
464
465 ------------------------
466 *.tex diff=tex
467 ------------------------
468
469 Then, you would define a "diff.tex.xfuncname" configuration to
470 specify a regular expression that matches a line that you would
471 want to appear as the hunk header "TEXT". Add a section to your
472 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
473
474 ------------------------
475 [diff "tex"]
476 xfuncname = "^(\\\\(sub)*section\\{.*)$"
477 ------------------------
478
479 Note. A single level of backslashes are eaten by the
480 configuration file parser, so you would need to double the
481 backslashes; the pattern above picks a line that begins with a
482 backslash, and zero or more occurrences of `sub` followed by
483 `section` followed by open brace, to the end of line.
484
485 There are a few built-in patterns to make this easier, and `tex`
486 is one of them, so you do not have to write the above in your
487 configuration file (you still need to enable this with the
488 attribute mechanism, via `.gitattributes`). The following built in
489 patterns are available:
490
491 - `bibtex` suitable for files with BibTeX coded references.
492
493 - `cpp` suitable for source code in the C and C++ languages.
494
495 - `csharp` suitable for source code in the C# language.
496
497 - `fortran` suitable for source code in the Fortran language.
498
499 - `html` suitable for HTML/XHTML documents.
500
501 - `java` suitable for source code in the Java language.
502
503 - `objc` suitable for source code in the Objective-C language.
504
505 - `pascal` suitable for source code in the Pascal/Delphi language.
506
507 - `php` suitable for source code in the PHP language.
508
509 - `python` suitable for source code in the Python language.
510
511 - `ruby` suitable for source code in the Ruby language.
512
513 - `tex` suitable for source code for LaTeX documents.
514
515
516 Customizing word diff
517 ^^^^^^^^^^^^^^^^^^^^^
518
519 You can customize the rules that `git diff --word-diff` uses to
520 split words in a line, by specifying an appropriate regular expression
521 in the "diff.*.wordRegex" configuration variable. For example, in TeX
522 a backslash followed by a sequence of letters forms a command, but
523 several such commands can be run together without intervening
524 whitespace. To separate them, use a regular expression in your
525 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
526
527 ------------------------
528 [diff "tex"]
529 wordRegex = "\\\\[a-zA-Z]+|[{}]|\\\\.|[^\\{}[:space:]]+"
530 ------------------------
531
532 A built-in pattern is provided for all languages listed in the
533 previous section.
534
535
536 Performing text diffs of binary files
537 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
538
539 Sometimes it is desirable to see the diff of a text-converted
540 version of some binary files. For example, a word processor
541 document can be converted to an ASCII text representation, and
542 the diff of the text shown. Even though this conversion loses
543 some information, the resulting diff is useful for human
544 viewing (but cannot be applied directly).
545
546 The `textconv` config option is used to define a program for
547 performing such a conversion. The program should take a single
548 argument, the name of a file to convert, and produce the
549 resulting text on stdout.
550
551 For example, to show the diff of the exif information of a
552 file instead of the binary information (assuming you have the
553 exif tool installed), add the following section to your
554 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file):
555
556 ------------------------
557 [diff "jpg"]
558 textconv = exif
559 ------------------------
560
561 NOTE: The text conversion is generally a one-way conversion;
562 in this example, we lose the actual image contents and focus
563 just on the text data. This means that diffs generated by
564 textconv are _not_ suitable for applying. For this reason,
565 only `git diff` and the `git log` family of commands (i.e.,
566 log, whatchanged, show) will perform text conversion. `git
567 format-patch` will never generate this output. If you want to
568 send somebody a text-converted diff of a binary file (e.g.,
569 because it quickly conveys the changes you have made), you
570 should generate it separately and send it as a comment _in
571 addition to_ the usual binary diff that you might send.
572
573 Because text conversion can be slow, especially when doing a
574 large number of them with `git log -p`, git provides a mechanism
575 to cache the output and use it in future diffs. To enable
576 caching, set the "cachetextconv" variable in your diff driver's
577 config. For example:
578
579 ------------------------
580 [diff "jpg"]
581 textconv = exif
582 cachetextconv = true
583 ------------------------
584
585 This will cache the result of running "exif" on each blob
586 indefinitely. If you change the textconv config variable for a
587 diff driver, git will automatically invalidate the cache entries
588 and re-run the textconv filter. If you want to invalidate the
589 cache manually (e.g., because your version of "exif" was updated
590 and now produces better output), you can remove the cache
591 manually with `git update-ref -d refs/notes/textconv/jpg` (where
592 "jpg" is the name of the diff driver, as in the example above).
593
594 Performing a three-way merge
595 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
596
597 `merge`
598 ^^^^^^^
599
600 The attribute `merge` affects how three versions of a file is
601 merged when a file-level merge is necessary during `git merge`,
602 and other commands such as `git revert` and `git cherry-pick`.
603
604 Set::
605
606 Built-in 3-way merge driver is used to merge the
607 contents in a way similar to 'merge' command of `RCS`
608 suite. This is suitable for ordinary text files.
609
610 Unset::
611
612 Take the version from the current branch as the
613 tentative merge result, and declare that the merge has
614 conflicts. This is suitable for binary files that does
615 not have a well-defined merge semantics.
616
617 Unspecified::
618
619 By default, this uses the same built-in 3-way merge
620 driver as is the case the `merge` attribute is set.
621 However, `merge.default` configuration variable can name
622 different merge driver to be used for paths to which the
623 `merge` attribute is unspecified.
624
625 String::
626
627 3-way merge is performed using the specified custom
628 merge driver. The built-in 3-way merge driver can be
629 explicitly specified by asking for "text" driver; the
630 built-in "take the current branch" driver can be
631 requested with "binary".
632
633
634 Built-in merge drivers
635 ^^^^^^^^^^^^^^^^^^^^^^
636
637 There are a few built-in low-level merge drivers defined that
638 can be asked for via the `merge` attribute.
639
640 text::
641
642 Usual 3-way file level merge for text files. Conflicted
643 regions are marked with conflict markers `<<<<<<<`,
644 `=======` and `>>>>>>>`. The version from your branch
645 appears before the `=======` marker, and the version
646 from the merged branch appears after the `=======`
647 marker.
648
649 binary::
650
651 Keep the version from your branch in the work tree, but
652 leave the path in the conflicted state for the user to
653 sort out.
654
655 union::
656
657 Run 3-way file level merge for text files, but take
658 lines from both versions, instead of leaving conflict
659 markers. This tends to leave the added lines in the
660 resulting file in random order and the user should
661 verify the result. Do not use this if you do not
662 understand the implications.
663
664
665 Defining a custom merge driver
666 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
667
668 The definition of a merge driver is done in the `.git/config`
669 file, not in the `gitattributes` file, so strictly speaking this
670 manual page is a wrong place to talk about it. However...
671
672 To define a custom merge driver `filfre`, add a section to your
673 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
674
675 ----------------------------------------------------------------
676 [merge "filfre"]
677 name = feel-free merge driver
678 driver = filfre %O %A %B
679 recursive = binary
680 ----------------------------------------------------------------
681
682 The `merge.*.name` variable gives the driver a human-readable
683 name.
684
685 The `merge.*.driver` variable's value is used to construct a
686 command to run to merge ancestor's version (`%O`), current
687 version (`%A`) and the other branches' version (`%B`). These
688 three tokens are replaced with the names of temporary files that
689 hold the contents of these versions when the command line is
690 built. Additionally, %L will be replaced with the conflict marker
691 size (see below).
692
693 The merge driver is expected to leave the result of the merge in
694 the file named with `%A` by overwriting it, and exit with zero
695 status if it managed to merge them cleanly, or non-zero if there
696 were conflicts.
697
698 The `merge.*.recursive` variable specifies what other merge
699 driver to use when the merge driver is called for an internal
700 merge between common ancestors, when there are more than one.
701 When left unspecified, the driver itself is used for both
702 internal merge and the final merge.
703
704
705 `conflict-marker-size`
706 ^^^^^^^^^^^^^^^^^^^^^^
707
708 This attribute controls the length of conflict markers left in
709 the work tree file during a conflicted merge. Only setting to
710 the value to a positive integer has any meaningful effect.
711
712 For example, this line in `.gitattributes` can be used to tell the merge
713 machinery to leave much longer (instead of the usual 7-character-long)
714 conflict markers when merging the file `Documentation/git-merge.txt`
715 results in a conflict.
716
717 ------------------------
718 Documentation/git-merge.txt conflict-marker-size=32
719 ------------------------
720
721
722 Checking whitespace errors
723 ~~~~~~~~~~~~~~~~~~~~~~~~~~
724
725 `whitespace`
726 ^^^^^^^^^^^^
727
728 The `core.whitespace` configuration variable allows you to define what
729 'diff' and 'apply' should consider whitespace errors for all paths in
730 the project (See linkgit:git-config[1]). This attribute gives you finer
731 control per path.
732
733 Set::
734
735 Notice all types of potential whitespace errors known to git.
736 The tab width is taken from the value of the `core.whitespace`
737 configuration variable.
738
739 Unset::
740
741 Do not notice anything as error.
742
743 Unspecified::
744
745 Use the value of the `core.whitespace` configuration variable to
746 decide what to notice as error.
747
748 String::
749
750 Specify a comma separate list of common whitespace problems to
751 notice in the same format as the `core.whitespace` configuration
752 variable.
753
754
755 Creating an archive
756 ~~~~~~~~~~~~~~~~~~~
757
758 `export-ignore`
759 ^^^^^^^^^^^^^^^
760
761 Files and directories with the attribute `export-ignore` won't be added to
762 archive files.
763
764 `export-subst`
765 ^^^^^^^^^^^^^^
766
767 If the attribute `export-subst` is set for a file then git will expand
768 several placeholders when adding this file to an archive. The
769 expansion depends on the availability of a commit ID, i.e., if
770 linkgit:git-archive[1] has been given a tree instead of a commit or a
771 tag then no replacement will be done. The placeholders are the same
772 as those for the option `--pretty=format:` of linkgit:git-log[1],
773 except that they need to be wrapped like this: `$Format:PLACEHOLDERS$`
774 in the file. E.g. the string `$Format:%H$` will be replaced by the
775 commit hash.
776
777
778 Packing objects
779 ~~~~~~~~~~~~~~~
780
781 `delta`
782 ^^^^^^^
783
784 Delta compression will not be attempted for blobs for paths with the
785 attribute `delta` set to false.
786
787
788 Viewing files in GUI tools
789 ~~~~~~~~~~~~~~~~~~~~~~~~~~
790
791 `encoding`
792 ^^^^^^^^^^
793
794 The value of this attribute specifies the character encoding that should
795 be used by GUI tools (e.g. linkgit:gitk[1] and linkgit:git-gui[1]) to
796 display the contents of the relevant file. Note that due to performance
797 considerations linkgit:gitk[1] does not use this attribute unless you
798 manually enable per-file encodings in its options.
799
800 If this attribute is not set or has an invalid value, the value of the
801 `gui.encoding` configuration variable is used instead
802 (See linkgit:git-config[1]).
803
804
805 USING ATTRIBUTE MACROS
806 ----------------------
807
808 You do not want any end-of-line conversions applied to, nor textual diffs
809 produced for, any binary file you track. You would need to specify e.g.
810
811 ------------
812 *.jpg -text -diff
813 ------------
814
815 but that may become cumbersome, when you have many attributes. Using
816 attribute macros, you can specify groups of attributes set or unset at
817 the same time. The system knows a built-in attribute macro, `binary`:
818
819 ------------
820 *.jpg binary
821 ------------
822
823 which is equivalent to the above. Note that the attribute macros can only
824 be "Set" (see the above example that sets "binary" macro as if it were an
825 ordinary attribute --- setting it in turn unsets "text" and "diff").
826
827
828 DEFINING ATTRIBUTE MACROS
829 -------------------------
830
831 Custom attribute macros can be defined only in the `.gitattributes` file
832 at the toplevel (i.e. not in any subdirectory). The built-in attribute
833 macro "binary" is equivalent to:
834
835 ------------
836 [attr]binary -diff -text
837 ------------
838
839
840 EXAMPLE
841 -------
842
843 If you have these three `gitattributes` file:
844
845 ----------------------------------------------------------------
846 (in $GIT_DIR/info/attributes)
847
848 a* foo !bar -baz
849
850 (in .gitattributes)
851 abc foo bar baz
852
853 (in t/.gitattributes)
854 ab* merge=filfre
855 abc -foo -bar
856 *.c frotz
857 ----------------------------------------------------------------
858
859 the attributes given to path `t/abc` are computed as follows:
860
861 1. By examining `t/.gitattributes` (which is in the same
862 directory as the path in question), git finds that the first
863 line matches. `merge` attribute is set. It also finds that
864 the second line matches, and attributes `foo` and `bar`
865 are unset.
866
867 2. Then it examines `.gitattributes` (which is in the parent
868 directory), and finds that the first line matches, but
869 `t/.gitattributes` file already decided how `merge`, `foo`
870 and `bar` attributes should be given to this path, so it
871 leaves `foo` and `bar` unset. Attribute `baz` is set.
872
873 3. Finally it examines `$GIT_DIR/info/attributes`. This file
874 is used to override the in-tree settings. The first line is
875 a match, and `foo` is set, `bar` is reverted to unspecified
876 state, and `baz` is unset.
877
878 As the result, the attributes assignment to `t/abc` becomes:
879
880 ----------------------------------------------------------------
881 foo set to true
882 bar unspecified
883 baz set to false
884 merge set to string value "filfre"
885 frotz unspecified
886 ----------------------------------------------------------------
887
888
889
890 GIT
891 ---
892 Part of the linkgit:git[1] suite