Git 1.8.0-rc3
[git.git] / Documentation / gitattributes.txt
blobba02d4de5901b4448411654ecdf76a1b1980e53b
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). Finally
66 global and system-wide files are considered (they have the lowest
67 precedence).
69 When the `.gitattributes` file is missing from the work tree, the
70 path in the index is used as a fall-back.  During checkout process,
71 `.gitattributes` in the index is used and then the file in the
72 working tree is used as a fall-back.
74 If you wish to affect only a single repository (i.e., to assign
75 attributes to files that are particular to
76 one user's workflow for that repository), then
77 attributes should be placed in the `$GIT_DIR/info/attributes` file.
78 Attributes which should be version-controlled and distributed to other
79 repositories (i.e., attributes of interest to all users) should go into
80 `.gitattributes` files. Attributes that should affect all repositories
81 for a single user should be placed in a file specified by the
82 `core.attributesfile` configuration option (see linkgit:git-config[1]).
83 Its default value is $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME
84 is either not set or empty, $HOME/.config/git/attributes is used instead.
85 Attributes for all users on a system should be placed in the
86 `$(prefix)/etc/gitattributes` file.
88 Sometimes you would need to override an setting of an attribute
89 for a path to `Unspecified` state.  This can be done by listing
90 the name of the attribute prefixed with an exclamation point `!`.
93 EFFECTS
94 -------
96 Certain operations by git can be influenced by assigning
97 particular attributes to a path.  Currently, the following
98 operations are attributes-aware.
100 Checking-out and checking-in
101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103 These attributes affect how the contents stored in the
104 repository are copied to the working tree files when commands
105 such as 'git checkout' and 'git merge' run.  They also affect how
106 git stores the contents you prepare in the working tree in the
107 repository upon 'git add' and 'git commit'.
109 `text`
110 ^^^^^^
112 This attribute enables and controls end-of-line normalization.  When a
113 text file is normalized, its line endings are converted to LF in the
114 repository.  To control what line ending style is used in the working
115 directory, use the `eol` attribute for a single file and the
116 `core.eol` configuration variable for all text files.
118 Set::
120         Setting the `text` attribute on a path enables end-of-line
121         normalization and marks the path as a text file.  End-of-line
122         conversion takes place without guessing the content type.
124 Unset::
126         Unsetting the `text` attribute on a path tells git not to
127         attempt any end-of-line conversion upon checkin or checkout.
129 Set to string value "auto"::
131         When `text` is set to "auto", the path is marked for automatic
132         end-of-line normalization.  If git decides that the content is
133         text, its line endings are normalized to LF on checkin.
135 Unspecified::
137         If the `text` attribute is unspecified, git uses the
138         `core.autocrlf` configuration variable to determine if the
139         file should be converted.
141 Any other value causes git to act as if `text` has been left
142 unspecified.
144 `eol`
145 ^^^^^
147 This attribute sets a specific line-ending style to be used in the
148 working directory.  It enables end-of-line normalization without any
149 content checks, effectively setting the `text` attribute.
151 Set to string value "crlf"::
153         This setting forces git to normalize line endings for this
154         file on checkin and convert them to CRLF when the file is
155         checked out.
157 Set to string value "lf"::
159         This setting forces git to normalize line endings to LF on
160         checkin and prevents conversion to CRLF when the file is
161         checked out.
163 Backwards compatibility with `crlf` attribute
164 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
166 For backwards compatibility, the `crlf` attribute is interpreted as
167 follows:
169 ------------------------
170 crlf            text
171 -crlf           -text
172 crlf=input      eol=lf
173 ------------------------
175 End-of-line conversion
176 ^^^^^^^^^^^^^^^^^^^^^^
178 While git normally leaves file contents alone, it can be configured to
179 normalize line endings to LF in the repository and, optionally, to
180 convert them to CRLF when files are checked out.
182 Here is an example that will make git normalize .txt, .vcproj and .sh
183 files, ensure that .vcproj files have CRLF and .sh files have LF in
184 the working directory, and prevent .jpg files from being normalized
185 regardless of their content.
187 ------------------------
188 *.txt           text
189 *.vcproj        eol=crlf
190 *.sh            eol=lf
191 *.jpg           -text
192 ------------------------
194 Other source code management systems normalize all text files in their
195 repositories, and there are two ways to enable similar automatic
196 normalization in git.
198 If you simply want to have CRLF line endings in your working directory
199 regardless of the repository you are working with, you can set the
200 config variable "core.autocrlf" without changing any attributes.
202 ------------------------
203 [core]
204         autocrlf = true
205 ------------------------
207 This does not force normalization of all text files, but does ensure
208 that text files that you introduce to the repository have their line
209 endings normalized to LF when they are added, and that files that are
210 already normalized in the repository stay normalized.
212 If you want to interoperate with a source code management system that
213 enforces end-of-line normalization, or you simply want all text files
214 in your repository to be normalized, you should instead set the `text`
215 attribute to "auto" for _all_ files.
217 ------------------------
218 *       text=auto
219 ------------------------
221 This ensures that all files that git considers to be text will have
222 normalized (LF) line endings in the repository.  The `core.eol`
223 configuration variable controls which line endings git will use for
224 normalized files in your working directory; the default is to use the
225 native line ending for your platform, or CRLF if `core.autocrlf` is
226 set.
228 NOTE: When `text=auto` normalization is enabled in an existing
229 repository, any text files containing CRLFs should be normalized.  If
230 they are not they will be normalized the next time someone tries to
231 change them, causing unfortunate misattribution.  From a clean working
232 directory:
234 -------------------------------------------------
235 $ echo "* text=auto" >>.gitattributes
236 $ rm .git/index     # Remove the index to force git to
237 $ git reset         # re-scan the working directory
238 $ git status        # Show files that will be normalized
239 $ git add -u
240 $ git add .gitattributes
241 $ git commit -m "Introduce end-of-line normalization"
242 -------------------------------------------------
244 If any files that should not be normalized show up in 'git status',
245 unset their `text` attribute before running 'git add -u'.
247 ------------------------
248 manual.pdf      -text
249 ------------------------
251 Conversely, text files that git does not detect can have normalization
252 enabled manually.
254 ------------------------
255 weirdchars.txt  text
256 ------------------------
258 If `core.safecrlf` is set to "true" or "warn", git verifies if
259 the conversion is reversible for the current setting of
260 `core.autocrlf`.  For "true", git rejects irreversible
261 conversions; for "warn", git only prints a warning but accepts
262 an irreversible conversion.  The safety triggers to prevent such
263 a conversion done to the files in the work tree, but there are a
264 few exceptions.  Even though...
266 - 'git add' itself does not touch the files in the work tree, the
267   next checkout would, so the safety triggers;
269 - 'git apply' to update a text file with a patch does touch the files
270   in the work tree, but the operation is about text files and CRLF
271   conversion is about fixing the line ending inconsistencies, so the
272   safety does not trigger;
274 - 'git diff' itself does not touch the files in the work tree, it is
275   often run to inspect the changes you intend to next 'git add'.  To
276   catch potential problems early, safety triggers.
279 `ident`
280 ^^^^^^^
282 When the attribute `ident` is set for a path, git replaces
283 `$Id$` in the blob object with `$Id:`, followed by the
284 40-character hexadecimal blob object name, followed by a dollar
285 sign `$` upon checkout.  Any byte sequence that begins with
286 `$Id:` and ends with `$` in the worktree file is replaced
287 with `$Id$` upon check-in.
290 `filter`
291 ^^^^^^^^
293 A `filter` attribute can be set to a string value that names a
294 filter driver specified in the configuration.
296 A filter driver consists of a `clean` command and a `smudge`
297 command, either of which can be left unspecified.  Upon
298 checkout, when the `smudge` command is specified, the command is
299 fed the blob object from its standard input, and its standard
300 output is used to update the worktree file.  Similarly, the
301 `clean` command is used to convert the contents of worktree file
302 upon checkin.
304 One use of the content filtering is to massage the content into a shape
305 that is more convenient for the platform, filesystem, and the user to use.
306 For this mode of operation, the key phrase here is "more convenient" and
307 not "turning something unusable into usable".  In other words, the intent
308 is that if someone unsets the filter driver definition, or does not have
309 the appropriate filter program, the project should still be usable.
311 Another use of the content filtering is to store the content that cannot
312 be directly used in the repository (e.g. a UUID that refers to the true
313 content stored outside git, or an encrypted content) and turn it into a
314 usable form upon checkout (e.g. download the external content, or decrypt
315 the encrypted content).
317 These two filters behave differently, and by default, a filter is taken as
318 the former, massaging the contents into more convenient shape.  A missing
319 filter driver definition in the config, or a filter driver that exits with
320 a non-zero status, is not an error but makes the filter a no-op passthru.
322 You can declare that a filter turns a content that by itself is unusable
323 into a usable content by setting the filter.<driver>.required configuration
324 variable to `true`.
326 For example, in .gitattributes, you would assign the `filter`
327 attribute for paths.
329 ------------------------
330 *.c     filter=indent
331 ------------------------
333 Then you would define a "filter.indent.clean" and "filter.indent.smudge"
334 configuration in your .git/config to specify a pair of commands to
335 modify the contents of C programs when the source files are checked
336 in ("clean" is run) and checked out (no change is made because the
337 command is "cat").
339 ------------------------
340 [filter "indent"]
341         clean = indent
342         smudge = cat
343 ------------------------
345 For best results, `clean` should not alter its output further if it is
346 run twice ("clean->clean" should be equivalent to "clean"), and
347 multiple `smudge` commands should not alter `clean`'s output
348 ("smudge->smudge->clean" should be equivalent to "clean").  See the
349 section on merging below.
351 The "indent" filter is well-behaved in this regard: it will not modify
352 input that is already correctly indented.  In this case, the lack of a
353 smudge filter means that the clean filter _must_ accept its own output
354 without modifying it.
356 If a filter _must_ succeed in order to make the stored contents usable,
357 you can declare that the filter is `required`, in the configuration:
359 ------------------------
360 [filter "crypt"]
361         clean = openssl enc ...
362         smudge = openssl enc -d ...
363         required
364 ------------------------
366 Sequence "%f" on the filter command line is replaced with the name of
367 the file the filter is working on.  A filter might use this in keyword
368 substitution.  For example:
370 ------------------------
371 [filter "p4"]
372         clean = git-p4-filter --clean %f
373         smudge = git-p4-filter --smudge %f
374 ------------------------
377 Interaction between checkin/checkout attributes
378 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
380 In the check-in codepath, the worktree file is first converted
381 with `filter` driver (if specified and corresponding driver
382 defined), then the result is processed with `ident` (if
383 specified), and then finally with `text` (again, if specified
384 and applicable).
386 In the check-out codepath, the blob content is first converted
387 with `text`, and then `ident` and fed to `filter`.
390 Merging branches with differing checkin/checkout attributes
391 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
393 If you have added attributes to a file that cause the canonical
394 repository format for that file to change, such as adding a
395 clean/smudge filter or text/eol/ident attributes, merging anything
396 where the attribute is not in place would normally cause merge
397 conflicts.
399 To prevent these unnecessary merge conflicts, git can be told to run a
400 virtual check-out and check-in of all three stages of a file when
401 resolving a three-way merge by setting the `merge.renormalize`
402 configuration variable.  This prevents changes caused by check-in
403 conversion from causing spurious merge conflicts when a converted file
404 is merged with an unconverted file.
406 As long as a "smudge->clean" results in the same output as a "clean"
407 even on files that are already smudged, this strategy will
408 automatically resolve all filter-related conflicts.  Filters that do
409 not act in this way may cause additional merge conflicts that must be
410 resolved manually.
413 Generating diff text
414 ~~~~~~~~~~~~~~~~~~~~
416 `diff`
417 ^^^^^^
419 The attribute `diff` affects how 'git' generates diffs for particular
420 files. It can tell git whether to generate a textual patch for the path
421 or to treat the path as a binary file.  It can also affect what line is
422 shown on the hunk header `@@ -k,l +n,m @@` line, tell git to use an
423 external command to generate the diff, or ask git to convert binary
424 files to a text format before generating the diff.
426 Set::
428         A path to which the `diff` attribute is set is treated
429         as text, even when they contain byte values that
430         normally never appear in text files, such as NUL.
432 Unset::
434         A path to which the `diff` attribute is unset will
435         generate `Binary files differ` (or a binary patch, if
436         binary patches are enabled).
438 Unspecified::
440         A path to which the `diff` attribute is unspecified
441         first gets its contents inspected, and if it looks like
442         text, it is treated as text.  Otherwise it would
443         generate `Binary files differ`.
445 String::
447         Diff is shown using the specified diff driver.  Each driver may
448         specify one or more options, as described in the following
449         section. The options for the diff driver "foo" are defined
450         by the configuration variables in the "diff.foo" section of the
451         git config file.
454 Defining an external diff driver
455 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
457 The definition of a diff driver is done in `gitconfig`, not
458 `gitattributes` file, so strictly speaking this manual page is a
459 wrong place to talk about it.  However...
461 To define an external diff driver `jcdiff`, add a section to your
462 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
464 ----------------------------------------------------------------
465 [diff "jcdiff"]
466         command = j-c-diff
467 ----------------------------------------------------------------
469 When git needs to show you a diff for the path with `diff`
470 attribute set to `jcdiff`, it calls the command you specified
471 with the above configuration, i.e. `j-c-diff`, with 7
472 parameters, just like `GIT_EXTERNAL_DIFF` program is called.
473 See linkgit:git[1] for details.
476 Defining a custom hunk-header
477 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
479 Each group of changes (called a "hunk") in the textual diff output
480 is prefixed with a line of the form:
482         @@ -k,l +n,m @@ TEXT
484 This is called a 'hunk header'.  The "TEXT" portion is by default a line
485 that begins with an alphabet, an underscore or a dollar sign; this
486 matches what GNU 'diff -p' output uses.  This default selection however
487 is not suited for some contents, and you can use a customized pattern
488 to make a selection.
490 First, in .gitattributes, you would assign the `diff` attribute
491 for paths.
493 ------------------------
494 *.tex   diff=tex
495 ------------------------
497 Then, you would define a "diff.tex.xfuncname" configuration to
498 specify a regular expression that matches a line that you would
499 want to appear as the hunk header "TEXT". Add a section to your
500 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
502 ------------------------
503 [diff "tex"]
504         xfuncname = "^(\\\\(sub)*section\\{.*)$"
505 ------------------------
507 Note.  A single level of backslashes are eaten by the
508 configuration file parser, so you would need to double the
509 backslashes; the pattern above picks a line that begins with a
510 backslash, and zero or more occurrences of `sub` followed by
511 `section` followed by open brace, to the end of line.
513 There are a few built-in patterns to make this easier, and `tex`
514 is one of them, so you do not have to write the above in your
515 configuration file (you still need to enable this with the
516 attribute mechanism, via `.gitattributes`).  The following built in
517 patterns are available:
519 - `ada` suitable for source code in the Ada language.
521 - `bibtex` suitable for files with BibTeX coded references.
523 - `cpp` suitable for source code in the C and C++ languages.
525 - `csharp` suitable for source code in the C# language.
527 - `fortran` suitable for source code in the Fortran language.
529 - `html` suitable for HTML/XHTML documents.
531 - `java` suitable for source code in the Java language.
533 - `matlab` suitable for source code in the MATLAB language.
535 - `objc` suitable for source code in the Objective-C language.
537 - `pascal` suitable for source code in the Pascal/Delphi language.
539 - `perl` suitable for source code in the Perl language.
541 - `php` suitable for source code in the PHP language.
543 - `python` suitable for source code in the Python language.
545 - `ruby` suitable for source code in the Ruby language.
547 - `tex` suitable for source code for LaTeX documents.
550 Customizing word diff
551 ^^^^^^^^^^^^^^^^^^^^^
553 You can customize the rules that `git diff --word-diff` uses to
554 split words in a line, by specifying an appropriate regular expression
555 in the "diff.*.wordRegex" configuration variable.  For example, in TeX
556 a backslash followed by a sequence of letters forms a command, but
557 several such commands can be run together without intervening
558 whitespace.  To separate them, use a regular expression in your
559 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
561 ------------------------
562 [diff "tex"]
563         wordRegex = "\\\\[a-zA-Z]+|[{}]|\\\\.|[^\\{}[:space:]]+"
564 ------------------------
566 A built-in pattern is provided for all languages listed in the
567 previous section.
570 Performing text diffs of binary files
571 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
573 Sometimes it is desirable to see the diff of a text-converted
574 version of some binary files. For example, a word processor
575 document can be converted to an ASCII text representation, and
576 the diff of the text shown. Even though this conversion loses
577 some information, the resulting diff is useful for human
578 viewing (but cannot be applied directly).
580 The `textconv` config option is used to define a program for
581 performing such a conversion. The program should take a single
582 argument, the name of a file to convert, and produce the
583 resulting text on stdout.
585 For example, to show the diff of the exif information of a
586 file instead of the binary information (assuming you have the
587 exif tool installed), add the following section to your
588 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file):
590 ------------------------
591 [diff "jpg"]
592         textconv = exif
593 ------------------------
595 NOTE: The text conversion is generally a one-way conversion;
596 in this example, we lose the actual image contents and focus
597 just on the text data. This means that diffs generated by
598 textconv are _not_ suitable for applying. For this reason,
599 only `git diff` and the `git log` family of commands (i.e.,
600 log, whatchanged, show) will perform text conversion. `git
601 format-patch` will never generate this output. If you want to
602 send somebody a text-converted diff of a binary file (e.g.,
603 because it quickly conveys the changes you have made), you
604 should generate it separately and send it as a comment _in
605 addition to_ the usual binary diff that you might send.
607 Because text conversion can be slow, especially when doing a
608 large number of them with `git log -p`, git provides a mechanism
609 to cache the output and use it in future diffs.  To enable
610 caching, set the "cachetextconv" variable in your diff driver's
611 config. For example:
613 ------------------------
614 [diff "jpg"]
615         textconv = exif
616         cachetextconv = true
617 ------------------------
619 This will cache the result of running "exif" on each blob
620 indefinitely. If you change the textconv config variable for a
621 diff driver, git will automatically invalidate the cache entries
622 and re-run the textconv filter. If you want to invalidate the
623 cache manually (e.g., because your version of "exif" was updated
624 and now produces better output), you can remove the cache
625 manually with `git update-ref -d refs/notes/textconv/jpg` (where
626 "jpg" is the name of the diff driver, as in the example above).
628 Choosing textconv versus external diff
629 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
631 If you want to show differences between binary or specially-formatted
632 blobs in your repository, you can choose to use either an external diff
633 command, or to use textconv to convert them to a diff-able text format.
634 Which method you choose depends on your exact situation.
636 The advantage of using an external diff command is flexibility. You are
637 not bound to find line-oriented changes, nor is it necessary for the
638 output to resemble unified diff. You are free to locate and report
639 changes in the most appropriate way for your data format.
641 A textconv, by comparison, is much more limiting. You provide a
642 transformation of the data into a line-oriented text format, and git
643 uses its regular diff tools to generate the output. There are several
644 advantages to choosing this method:
646 1. Ease of use. It is often much simpler to write a binary to text
647    transformation than it is to perform your own diff. In many cases,
648    existing programs can be used as textconv filters (e.g., exif,
649    odt2txt).
651 2. Git diff features. By performing only the transformation step
652    yourself, you can still utilize many of git's diff features,
653    including colorization, word-diff, and combined diffs for merges.
655 3. Caching. Textconv caching can speed up repeated diffs, such as those
656    you might trigger by running `git log -p`.
659 Marking files as binary
660 ^^^^^^^^^^^^^^^^^^^^^^^
662 Git usually guesses correctly whether a blob contains text or binary
663 data by examining the beginning of the contents. However, sometimes you
664 may want to override its decision, either because a blob contains binary
665 data later in the file, or because the content, while technically
666 composed of text characters, is opaque to a human reader. For example,
667 many postscript files contain only ascii characters, but produce noisy
668 and meaningless diffs.
670 The simplest way to mark a file as binary is to unset the diff
671 attribute in the `.gitattributes` file:
673 ------------------------
674 *.ps -diff
675 ------------------------
677 This will cause git to generate `Binary files differ` (or a binary
678 patch, if binary patches are enabled) instead of a regular diff.
680 However, one may also want to specify other diff driver attributes. For
681 example, you might want to use `textconv` to convert postscript files to
682 an ascii representation for human viewing, but otherwise treat them as
683 binary files. You cannot specify both `-diff` and `diff=ps` attributes.
684 The solution is to use the `diff.*.binary` config option:
686 ------------------------
687 [diff "ps"]
688   textconv = ps2ascii
689   binary = true
690 ------------------------
692 Performing a three-way merge
693 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
695 `merge`
696 ^^^^^^^
698 The attribute `merge` affects how three versions of a file are
699 merged when a file-level merge is necessary during `git merge`,
700 and other commands such as `git revert` and `git cherry-pick`.
702 Set::
704         Built-in 3-way merge driver is used to merge the
705         contents in a way similar to 'merge' command of `RCS`
706         suite.  This is suitable for ordinary text files.
708 Unset::
710         Take the version from the current branch as the
711         tentative merge result, and declare that the merge has
712         conflicts.  This is suitable for binary files that do
713         not have a well-defined merge semantics.
715 Unspecified::
717         By default, this uses the same built-in 3-way merge
718         driver as is the case when the `merge` attribute is set.
719         However, the `merge.default` configuration variable can name
720         different merge driver to be used with paths for which the
721         `merge` attribute is unspecified.
723 String::
725         3-way merge is performed using the specified custom
726         merge driver.  The built-in 3-way merge driver can be
727         explicitly specified by asking for "text" driver; the
728         built-in "take the current branch" driver can be
729         requested with "binary".
732 Built-in merge drivers
733 ^^^^^^^^^^^^^^^^^^^^^^
735 There are a few built-in low-level merge drivers defined that
736 can be asked for via the `merge` attribute.
738 text::
740         Usual 3-way file level merge for text files.  Conflicted
741         regions are marked with conflict markers `<<<<<<<`,
742         `=======` and `>>>>>>>`.  The version from your branch
743         appears before the `=======` marker, and the version
744         from the merged branch appears after the `=======`
745         marker.
747 binary::
749         Keep the version from your branch in the work tree, but
750         leave the path in the conflicted state for the user to
751         sort out.
753 union::
755         Run 3-way file level merge for text files, but take
756         lines from both versions, instead of leaving conflict
757         markers.  This tends to leave the added lines in the
758         resulting file in random order and the user should
759         verify the result. Do not use this if you do not
760         understand the implications.
763 Defining a custom merge driver
764 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
766 The definition of a merge driver is done in the `.git/config`
767 file, not in the `gitattributes` file, so strictly speaking this
768 manual page is a wrong place to talk about it.  However...
770 To define a custom merge driver `filfre`, add a section to your
771 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
773 ----------------------------------------------------------------
774 [merge "filfre"]
775         name = feel-free merge driver
776         driver = filfre %O %A %B
777         recursive = binary
778 ----------------------------------------------------------------
780 The `merge.*.name` variable gives the driver a human-readable
781 name.
783 The `merge.*.driver` variable's value is used to construct a
784 command to run to merge ancestor's version (`%O`), current
785 version (`%A`) and the other branches' version (`%B`).  These
786 three tokens are replaced with the names of temporary files that
787 hold the contents of these versions when the command line is
788 built. Additionally, %L will be replaced with the conflict marker
789 size (see below).
791 The merge driver is expected to leave the result of the merge in
792 the file named with `%A` by overwriting it, and exit with zero
793 status if it managed to merge them cleanly, or non-zero if there
794 were conflicts.
796 The `merge.*.recursive` variable specifies what other merge
797 driver to use when the merge driver is called for an internal
798 merge between common ancestors, when there are more than one.
799 When left unspecified, the driver itself is used for both
800 internal merge and the final merge.
803 `conflict-marker-size`
804 ^^^^^^^^^^^^^^^^^^^^^^
806 This attribute controls the length of conflict markers left in
807 the work tree file during a conflicted merge.  Only setting to
808 the value to a positive integer has any meaningful effect.
810 For example, this line in `.gitattributes` can be used to tell the merge
811 machinery to leave much longer (instead of the usual 7-character-long)
812 conflict markers when merging the file `Documentation/git-merge.txt`
813 results in a conflict.
815 ------------------------
816 Documentation/git-merge.txt     conflict-marker-size=32
817 ------------------------
820 Checking whitespace errors
821 ~~~~~~~~~~~~~~~~~~~~~~~~~~
823 `whitespace`
824 ^^^^^^^^^^^^
826 The `core.whitespace` configuration variable allows you to define what
827 'diff' and 'apply' should consider whitespace errors for all paths in
828 the project (See linkgit:git-config[1]).  This attribute gives you finer
829 control per path.
831 Set::
833         Notice all types of potential whitespace errors known to git.
834         The tab width is taken from the value of the `core.whitespace`
835         configuration variable.
837 Unset::
839         Do not notice anything as error.
841 Unspecified::
843         Use the value of the `core.whitespace` configuration variable to
844         decide what to notice as error.
846 String::
848         Specify a comma separate list of common whitespace problems to
849         notice in the same format as the `core.whitespace` configuration
850         variable.
853 Creating an archive
854 ~~~~~~~~~~~~~~~~~~~
856 `export-ignore`
857 ^^^^^^^^^^^^^^^
859 Files and directories with the attribute `export-ignore` won't be added to
860 archive files.
862 `export-subst`
863 ^^^^^^^^^^^^^^
865 If the attribute `export-subst` is set for a file then git will expand
866 several placeholders when adding this file to an archive.  The
867 expansion depends on the availability of a commit ID, i.e., if
868 linkgit:git-archive[1] has been given a tree instead of a commit or a
869 tag then no replacement will be done.  The placeholders are the same
870 as those for the option `--pretty=format:` of linkgit:git-log[1],
871 except that they need to be wrapped like this: `$Format:PLACEHOLDERS$`
872 in the file.  E.g. the string `$Format:%H$` will be replaced by the
873 commit hash.
876 Packing objects
877 ~~~~~~~~~~~~~~~
879 `delta`
880 ^^^^^^^
882 Delta compression will not be attempted for blobs for paths with the
883 attribute `delta` set to false.
886 Viewing files in GUI tools
887 ~~~~~~~~~~~~~~~~~~~~~~~~~~
889 `encoding`
890 ^^^^^^^^^^
892 The value of this attribute specifies the character encoding that should
893 be used by GUI tools (e.g. linkgit:gitk[1] and linkgit:git-gui[1]) to
894 display the contents of the relevant file. Note that due to performance
895 considerations linkgit:gitk[1] does not use this attribute unless you
896 manually enable per-file encodings in its options.
898 If this attribute is not set or has an invalid value, the value of the
899 `gui.encoding` configuration variable is used instead
900 (See linkgit:git-config[1]).
903 USING MACRO ATTRIBUTES
904 ----------------------
906 You do not want any end-of-line conversions applied to, nor textual diffs
907 produced for, any binary file you track.  You would need to specify e.g.
909 ------------
910 *.jpg -text -diff
911 ------------
913 but that may become cumbersome, when you have many attributes.  Using
914 macro attributes, you can define an attribute that, when set, also
915 sets or unsets a number of other attributes at the same time.  The
916 system knows a built-in macro attribute, `binary`:
918 ------------
919 *.jpg binary
920 ------------
922 Setting the "binary" attribute also unsets the "text" and "diff"
923 attributes as above.  Note that macro attributes can only be "Set",
924 though setting one might have the effect of setting or unsetting other
925 attributes or even returning other attributes to the "Unspecified"
926 state.
929 DEFINING MACRO ATTRIBUTES
930 -------------------------
932 Custom macro attributes can be defined only in the `.gitattributes`
933 file at the toplevel (i.e. not in any subdirectory).  The built-in
934 macro attribute "binary" is equivalent to:
936 ------------
937 [attr]binary -diff -merge -text
938 ------------
941 EXAMPLE
942 -------
944 If you have these three `gitattributes` file:
946 ----------------------------------------------------------------
947 (in $GIT_DIR/info/attributes)
949 a*      foo !bar -baz
951 (in .gitattributes)
952 abc     foo bar baz
954 (in t/.gitattributes)
955 ab*     merge=filfre
956 abc     -foo -bar
957 *.c     frotz
958 ----------------------------------------------------------------
960 the attributes given to path `t/abc` are computed as follows:
962 1. By examining `t/.gitattributes` (which is in the same
963    directory as the path in question), git finds that the first
964    line matches.  `merge` attribute is set.  It also finds that
965    the second line matches, and attributes `foo` and `bar`
966    are unset.
968 2. Then it examines `.gitattributes` (which is in the parent
969    directory), and finds that the first line matches, but
970    `t/.gitattributes` file already decided how `merge`, `foo`
971    and `bar` attributes should be given to this path, so it
972    leaves `foo` and `bar` unset.  Attribute `baz` is set.
974 3. Finally it examines `$GIT_DIR/info/attributes`.  This file
975    is used to override the in-tree settings.  The first line is
976    a match, and `foo` is set, `bar` is reverted to unspecified
977    state, and `baz` is unset.
979 As the result, the attributes assignment to `t/abc` becomes:
981 ----------------------------------------------------------------
982 foo     set to true
983 bar     unspecified
984 baz     set to false
985 merge   set to string value "filfre"
986 frotz   unspecified
987 ----------------------------------------------------------------
990 SEE ALSO
991 --------
992 linkgit:git-check-attr[1].
996 Part of the linkgit:git[1] suite