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