git-p4: add test for p4 labels
[git.git] / Documentation / gitattributes.txt
bloba85b187e0479b99e137160c1190f174d80675fa1
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 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.
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 `!`.
86 EFFECTS
87 -------
89 Certain operations by git can be influenced by assigning
90 particular attributes to a path.  Currently, the following
91 operations are attributes-aware.
93 Checking-out and checking-in
94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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'.
102 `text`
103 ^^^^^^
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.
111 Set::
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.
117 Unset::
119         Unsetting the `text` attribute on a path tells git not to
120         attempt any end-of-line conversion upon checkin or checkout.
122 Set to string value "auto"::
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.
128 Unspecified::
130         If the `text` attribute is unspecified, git uses the
131         `core.autocrlf` configuration variable to determine if the
132         file should be converted.
134 Any other value causes git to act as if `text` has been left
135 unspecified.
137 `eol`
138 ^^^^^
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.
144 Set to string value "crlf"::
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.
150 Set to string value "lf"::
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.
156 Backwards compatibility with `crlf` attribute
157 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
159 For backwards compatibility, the `crlf` attribute is interpreted as
160 follows:
162 ------------------------
163 crlf            text
164 -crlf           -text
165 crlf=input      eol=lf
166 ------------------------
168 End-of-line conversion
169 ^^^^^^^^^^^^^^^^^^^^^^
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.
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.
180 ------------------------
181 *.txt           text
182 *.vcproj        eol=crlf
183 *.sh            eol=lf
184 *.jpg           -text
185 ------------------------
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.
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.
195 ------------------------
196 [core]
197         autocrlf = true
198 ------------------------
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.
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.
210 ------------------------
211 *       text=auto
212 ------------------------
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.
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:
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 -------------------------------------------------
237 If any files that should not be normalized show up in 'git status',
238 unset their `text` attribute before running 'git add -u'.
240 ------------------------
241 manual.pdf      -text
242 ------------------------
244 Conversely, text files that git does not detect can have normalization
245 enabled manually.
247 ------------------------
248 weirdchars.txt  text
249 ------------------------
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...
259 - 'git add' itself does not touch the files in the work tree, the
260   next checkout would, so the safety triggers;
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;
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.
272 `ident`
273 ^^^^^^^
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.
283 `filter`
284 ^^^^^^^^
286 A `filter` attribute can be set to a string value that names a
287 filter driver specified in the configuration.
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.
297 A missing filter driver definition in the config is not an error
298 but makes the filter a no-op passthru.
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.
308 For example, in .gitattributes, you would assign the `filter`
309 attribute for paths.
311 ------------------------
312 *.c     filter=indent
313 ------------------------
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").
321 ------------------------
322 [filter "indent"]
323         clean = indent
324         smudge = cat
325 ------------------------
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.
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.
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:
342 ------------------------
343 [filter "p4"]
344         clean = git-p4-filter --clean %f
345         smudge = git-p4-filter --smudge %f
346 ------------------------
349 Interaction between checkin/checkout attributes
350 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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).
358 In the check-out codepath, the blob content is first converted
359 with `text`, and then `ident` and fed to `filter`.
362 Merging branches with differing checkin/checkout attributes
363 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
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.
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.
385 Generating diff text
386 ~~~~~~~~~~~~~~~~~~~~
388 `diff`
389 ^^^^^^
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.
398 Set::
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.
404 Unset::
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).
410 Unspecified::
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`.
417 String::
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.
426 Defining an external diff driver
427 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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...
433 To define an external diff driver `jcdiff`, add a section to your
434 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
436 ----------------------------------------------------------------
437 [diff "jcdiff"]
438         command = j-c-diff
439 ----------------------------------------------------------------
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.
448 Defining a custom hunk-header
449 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
451 Each group of changes (called a "hunk") in the textual diff output
452 is prefixed with a line of the form:
454         @@ -k,l +n,m @@ TEXT
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.
462 First, in .gitattributes, you would assign the `diff` attribute
463 for paths.
465 ------------------------
466 *.tex   diff=tex
467 ------------------------
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:
474 ------------------------
475 [diff "tex"]
476         xfuncname = "^(\\\\(sub)*section\\{.*)$"
477 ------------------------
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.
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:
491 - `bibtex` suitable for files with BibTeX coded references.
493 - `cpp` suitable for source code in the C and C++ languages.
495 - `csharp` suitable for source code in the C# language.
497 - `fortran` suitable for source code in the Fortran language.
499 - `html` suitable for HTML/XHTML documents.
501 - `java` suitable for source code in the Java language.
503 - `matlab` suitable for source code in the MATLAB language.
505 - `objc` suitable for source code in the Objective-C language.
507 - `pascal` suitable for source code in the Pascal/Delphi language.
509 - `perl` suitable for source code in the Perl language.
511 - `php` suitable for source code in the PHP language.
513 - `python` suitable for source code in the Python language.
515 - `ruby` suitable for source code in the Ruby language.
517 - `tex` suitable for source code for LaTeX documents.
520 Customizing word diff
521 ^^^^^^^^^^^^^^^^^^^^^
523 You can customize the rules that `git diff --word-diff` uses to
524 split words in a line, by specifying an appropriate regular expression
525 in the "diff.*.wordRegex" configuration variable.  For example, in TeX
526 a backslash followed by a sequence of letters forms a command, but
527 several such commands can be run together without intervening
528 whitespace.  To separate them, use a regular expression in your
529 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
531 ------------------------
532 [diff "tex"]
533         wordRegex = "\\\\[a-zA-Z]+|[{}]|\\\\.|[^\\{}[:space:]]+"
534 ------------------------
536 A built-in pattern is provided for all languages listed in the
537 previous section.
540 Performing text diffs of binary files
541 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
543 Sometimes it is desirable to see the diff of a text-converted
544 version of some binary files. For example, a word processor
545 document can be converted to an ASCII text representation, and
546 the diff of the text shown. Even though this conversion loses
547 some information, the resulting diff is useful for human
548 viewing (but cannot be applied directly).
550 The `textconv` config option is used to define a program for
551 performing such a conversion. The program should take a single
552 argument, the name of a file to convert, and produce the
553 resulting text on stdout.
555 For example, to show the diff of the exif information of a
556 file instead of the binary information (assuming you have the
557 exif tool installed), add the following section to your
558 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file):
560 ------------------------
561 [diff "jpg"]
562         textconv = exif
563 ------------------------
565 NOTE: The text conversion is generally a one-way conversion;
566 in this example, we lose the actual image contents and focus
567 just on the text data. This means that diffs generated by
568 textconv are _not_ suitable for applying. For this reason,
569 only `git diff` and the `git log` family of commands (i.e.,
570 log, whatchanged, show) will perform text conversion. `git
571 format-patch` will never generate this output. If you want to
572 send somebody a text-converted diff of a binary file (e.g.,
573 because it quickly conveys the changes you have made), you
574 should generate it separately and send it as a comment _in
575 addition to_ the usual binary diff that you might send.
577 Because text conversion can be slow, especially when doing a
578 large number of them with `git log -p`, git provides a mechanism
579 to cache the output and use it in future diffs.  To enable
580 caching, set the "cachetextconv" variable in your diff driver's
581 config. For example:
583 ------------------------
584 [diff "jpg"]
585         textconv = exif
586         cachetextconv = true
587 ------------------------
589 This will cache the result of running "exif" on each blob
590 indefinitely. If you change the textconv config variable for a
591 diff driver, git will automatically invalidate the cache entries
592 and re-run the textconv filter. If you want to invalidate the
593 cache manually (e.g., because your version of "exif" was updated
594 and now produces better output), you can remove the cache
595 manually with `git update-ref -d refs/notes/textconv/jpg` (where
596 "jpg" is the name of the diff driver, as in the example above).
598 Choosing textconv versus external diff
599 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
601 If you want to show differences between binary or specially-formatted
602 blobs in your repository, you can choose to use either an external diff
603 command, or to use textconv to convert them to a diff-able text format.
604 Which method you choose depends on your exact situation.
606 The advantage of using an external diff command is flexibility. You are
607 not bound to find line-oriented changes, nor is it necessary for the
608 output to resemble unified diff. You are free to locate and report
609 changes in the most appropriate way for your data format.
611 A textconv, by comparison, is much more limiting. You provide a
612 transformation of the data into a line-oriented text format, and git
613 uses its regular diff tools to generate the output. There are several
614 advantages to choosing this method:
616 1. Ease of use. It is often much simpler to write a binary to text
617    transformation than it is to perform your own diff. In many cases,
618    existing programs can be used as textconv filters (e.g., exif,
619    odt2txt).
621 2. Git diff features. By performing only the transformation step
622    yourself, you can still utilize many of git's diff features,
623    including colorization, word-diff, and combined diffs for merges.
625 3. Caching. Textconv caching can speed up repeated diffs, such as those
626    you might trigger by running `git log -p`.
629 Marking files as binary
630 ^^^^^^^^^^^^^^^^^^^^^^^
632 Git usually guesses correctly whether a blob contains text or binary
633 data by examining the beginning of the contents. However, sometimes you
634 may want to override its decision, either because a blob contains binary
635 data later in the file, or because the content, while technically
636 composed of text characters, is opaque to a human reader. For example,
637 many postscript files contain only ascii characters, but produce noisy
638 and meaningless diffs.
640 The simplest way to mark a file as binary is to unset the diff
641 attribute in the `.gitattributes` file:
643 ------------------------
644 *.ps -diff
645 ------------------------
647 This will cause git to generate `Binary files differ` (or a binary
648 patch, if binary patches are enabled) instead of a regular diff.
650 However, one may also want to specify other diff driver attributes. For
651 example, you might want to use `textconv` to convert postscript files to
652 an ascii representation for human viewing, but otherwise treat them as
653 binary files. You cannot specify both `-diff` and `diff=ps` attributes.
654 The solution is to use the `diff.*.binary` config option:
656 ------------------------
657 [diff "ps"]
658   textconv = ps2ascii
659   binary = true
660 ------------------------
662 Performing a three-way merge
663 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
665 `merge`
666 ^^^^^^^
668 The attribute `merge` affects how three versions of a file are
669 merged when a file-level merge is necessary during `git merge`,
670 and other commands such as `git revert` and `git cherry-pick`.
672 Set::
674         Built-in 3-way merge driver is used to merge the
675         contents in a way similar to 'merge' command of `RCS`
676         suite.  This is suitable for ordinary text files.
678 Unset::
680         Take the version from the current branch as the
681         tentative merge result, and declare that the merge has
682         conflicts.  This is suitable for binary files that do
683         not have a well-defined merge semantics.
685 Unspecified::
687         By default, this uses the same built-in 3-way merge
688         driver as is the case when the `merge` attribute is set.
689         However, the `merge.default` configuration variable can name
690         different merge driver to be used with paths for which the
691         `merge` attribute is unspecified.
693 String::
695         3-way merge is performed using the specified custom
696         merge driver.  The built-in 3-way merge driver can be
697         explicitly specified by asking for "text" driver; the
698         built-in "take the current branch" driver can be
699         requested with "binary".
702 Built-in merge drivers
703 ^^^^^^^^^^^^^^^^^^^^^^
705 There are a few built-in low-level merge drivers defined that
706 can be asked for via the `merge` attribute.
708 text::
710         Usual 3-way file level merge for text files.  Conflicted
711         regions are marked with conflict markers `<<<<<<<`,
712         `=======` and `>>>>>>>`.  The version from your branch
713         appears before the `=======` marker, and the version
714         from the merged branch appears after the `=======`
715         marker.
717 binary::
719         Keep the version from your branch in the work tree, but
720         leave the path in the conflicted state for the user to
721         sort out.
723 union::
725         Run 3-way file level merge for text files, but take
726         lines from both versions, instead of leaving conflict
727         markers.  This tends to leave the added lines in the
728         resulting file in random order and the user should
729         verify the result. Do not use this if you do not
730         understand the implications.
733 Defining a custom merge driver
734 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
736 The definition of a merge driver is done in the `.git/config`
737 file, not in the `gitattributes` file, so strictly speaking this
738 manual page is a wrong place to talk about it.  However...
740 To define a custom merge driver `filfre`, add a section to your
741 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
743 ----------------------------------------------------------------
744 [merge "filfre"]
745         name = feel-free merge driver
746         driver = filfre %O %A %B
747         recursive = binary
748 ----------------------------------------------------------------
750 The `merge.*.name` variable gives the driver a human-readable
751 name.
753 The `merge.*.driver` variable's value is used to construct a
754 command to run to merge ancestor's version (`%O`), current
755 version (`%A`) and the other branches' version (`%B`).  These
756 three tokens are replaced with the names of temporary files that
757 hold the contents of these versions when the command line is
758 built. Additionally, %L will be replaced with the conflict marker
759 size (see below).
761 The merge driver is expected to leave the result of the merge in
762 the file named with `%A` by overwriting it, and exit with zero
763 status if it managed to merge them cleanly, or non-zero if there
764 were conflicts.
766 The `merge.*.recursive` variable specifies what other merge
767 driver to use when the merge driver is called for an internal
768 merge between common ancestors, when there are more than one.
769 When left unspecified, the driver itself is used for both
770 internal merge and the final merge.
773 `conflict-marker-size`
774 ^^^^^^^^^^^^^^^^^^^^^^
776 This attribute controls the length of conflict markers left in
777 the work tree file during a conflicted merge.  Only setting to
778 the value to a positive integer has any meaningful effect.
780 For example, this line in `.gitattributes` can be used to tell the merge
781 machinery to leave much longer (instead of the usual 7-character-long)
782 conflict markers when merging the file `Documentation/git-merge.txt`
783 results in a conflict.
785 ------------------------
786 Documentation/git-merge.txt     conflict-marker-size=32
787 ------------------------
790 Checking whitespace errors
791 ~~~~~~~~~~~~~~~~~~~~~~~~~~
793 `whitespace`
794 ^^^^^^^^^^^^
796 The `core.whitespace` configuration variable allows you to define what
797 'diff' and 'apply' should consider whitespace errors for all paths in
798 the project (See linkgit:git-config[1]).  This attribute gives you finer
799 control per path.
801 Set::
803         Notice all types of potential whitespace errors known to git.
804         The tab width is taken from the value of the `core.whitespace`
805         configuration variable.
807 Unset::
809         Do not notice anything as error.
811 Unspecified::
813         Use the value of the `core.whitespace` configuration variable to
814         decide what to notice as error.
816 String::
818         Specify a comma separate list of common whitespace problems to
819         notice in the same format as the `core.whitespace` configuration
820         variable.
823 Creating an archive
824 ~~~~~~~~~~~~~~~~~~~
826 `export-ignore`
827 ^^^^^^^^^^^^^^^
829 Files and directories with the attribute `export-ignore` won't be added to
830 archive files.
832 `export-subst`
833 ^^^^^^^^^^^^^^
835 If the attribute `export-subst` is set for a file then git will expand
836 several placeholders when adding this file to an archive.  The
837 expansion depends on the availability of a commit ID, i.e., if
838 linkgit:git-archive[1] has been given a tree instead of a commit or a
839 tag then no replacement will be done.  The placeholders are the same
840 as those for the option `--pretty=format:` of linkgit:git-log[1],
841 except that they need to be wrapped like this: `$Format:PLACEHOLDERS$`
842 in the file.  E.g. the string `$Format:%H$` will be replaced by the
843 commit hash.
846 Packing objects
847 ~~~~~~~~~~~~~~~
849 `delta`
850 ^^^^^^^
852 Delta compression will not be attempted for blobs for paths with the
853 attribute `delta` set to false.
856 Viewing files in GUI tools
857 ~~~~~~~~~~~~~~~~~~~~~~~~~~
859 `encoding`
860 ^^^^^^^^^^
862 The value of this attribute specifies the character encoding that should
863 be used by GUI tools (e.g. linkgit:gitk[1] and linkgit:git-gui[1]) to
864 display the contents of the relevant file. Note that due to performance
865 considerations linkgit:gitk[1] does not use this attribute unless you
866 manually enable per-file encodings in its options.
868 If this attribute is not set or has an invalid value, the value of the
869 `gui.encoding` configuration variable is used instead
870 (See linkgit:git-config[1]).
873 USING MACRO ATTRIBUTES
874 ----------------------
876 You do not want any end-of-line conversions applied to, nor textual diffs
877 produced for, any binary file you track.  You would need to specify e.g.
879 ------------
880 *.jpg -text -diff
881 ------------
883 but that may become cumbersome, when you have many attributes.  Using
884 macro attributes, you can define an attribute that, when set, also
885 sets or unsets a number of other attributes at the same time.  The
886 system knows a built-in macro attribute, `binary`:
888 ------------
889 *.jpg binary
890 ------------
892 Setting the "binary" attribute also unsets the "text" and "diff"
893 attributes as above.  Note that macro attributes can only be "Set",
894 though setting one might have the effect of setting or unsetting other
895 attributes or even returning other attributes to the "Unspecified"
896 state.
899 DEFINING MACRO ATTRIBUTES
900 -------------------------
902 Custom macro attributes can be defined only in the `.gitattributes`
903 file at the toplevel (i.e. not in any subdirectory).  The built-in
904 macro attribute "binary" is equivalent to:
906 ------------
907 [attr]binary -diff -text
908 ------------
911 EXAMPLE
912 -------
914 If you have these three `gitattributes` file:
916 ----------------------------------------------------------------
917 (in $GIT_DIR/info/attributes)
919 a*      foo !bar -baz
921 (in .gitattributes)
922 abc     foo bar baz
924 (in t/.gitattributes)
925 ab*     merge=filfre
926 abc     -foo -bar
927 *.c     frotz
928 ----------------------------------------------------------------
930 the attributes given to path `t/abc` are computed as follows:
932 1. By examining `t/.gitattributes` (which is in the same
933    directory as the path in question), git finds that the first
934    line matches.  `merge` attribute is set.  It also finds that
935    the second line matches, and attributes `foo` and `bar`
936    are unset.
938 2. Then it examines `.gitattributes` (which is in the parent
939    directory), and finds that the first line matches, but
940    `t/.gitattributes` file already decided how `merge`, `foo`
941    and `bar` attributes should be given to this path, so it
942    leaves `foo` and `bar` unset.  Attribute `baz` is set.
944 3. Finally it examines `$GIT_DIR/info/attributes`.  This file
945    is used to override the in-tree settings.  The first line is
946    a match, and `foo` is set, `bar` is reverted to unspecified
947    state, and `baz` is unset.
949 As the result, the attributes assignment to `t/abc` becomes:
951 ----------------------------------------------------------------
952 foo     set to true
953 bar     unspecified
954 baz     set to false
955 merge   set to string value "filfre"
956 frotz   unspecified
957 ----------------------------------------------------------------
960 SEE ALSO
961 --------
962 linkgit:git-check-attr[1].
966 Part of the linkgit:git[1] suite