Sleep 1 millisecond in poll() to avoid busy wait
[git/dscho.git] / Documentation / gitattributes.txt
blob80120ea14f1ccd2784405c2bf2d54863bb52e8d3
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 One use of the content filtering is to massage the content into a shape
298 that is more convenient for the platform, filesystem, and the user to use.
299 For this mode of operation, the key phrase here is "more convenient" and
300 not "turning something unusable into usable".  In other words, the intent
301 is that if someone unsets the filter driver definition, or does not have
302 the appropriate filter program, the project should still be usable.
304 Another use of the content filtering is to store the content that cannot
305 be directly used in the repository (e.g. a UUID that refers to the true
306 content stored outside git, or an encrypted content) and turn it into a
307 usable form upon checkout (e.g. download the external content, or decrypt
308 the encrypted content).
310 These two filters behave differently, and by default, a filter is taken as
311 the former, massaging the contents into more convenient shape.  A missing
312 filter driver definition in the config, or a filter driver that exits with
313 a non-zero status, is not an error but makes the filter a no-op passthru.
315 You can declare that a filter turns a content that by itself is unusable
316 into a usable content by setting the filter.<driver>.required configuration
317 variable to `true`.
319 For example, in .gitattributes, you would assign the `filter`
320 attribute for paths.
322 ------------------------
323 *.c     filter=indent
324 ------------------------
326 Then you would define a "filter.indent.clean" and "filter.indent.smudge"
327 configuration in your .git/config to specify a pair of commands to
328 modify the contents of C programs when the source files are checked
329 in ("clean" is run) and checked out (no change is made because the
330 command is "cat").
332 ------------------------
333 [filter "indent"]
334         clean = indent
335         smudge = cat
336 ------------------------
338 For best results, `clean` should not alter its output further if it is
339 run twice ("clean->clean" should be equivalent to "clean"), and
340 multiple `smudge` commands should not alter `clean`'s output
341 ("smudge->smudge->clean" should be equivalent to "clean").  See the
342 section on merging below.
344 The "indent" filter is well-behaved in this regard: it will not modify
345 input that is already correctly indented.  In this case, the lack of a
346 smudge filter means that the clean filter _must_ accept its own output
347 without modifying it.
349 If a filter _must_ succeed in order to make the stored contents usable,
350 you can declare that the filter is `required`, in the configuration:
352 ------------------------
353 [filter "crypt"]
354         clean = openssl enc ...
355         smudge = openssl enc -d ...
356         required
357 ------------------------
359 Sequence "%f" on the filter command line is replaced with the name of
360 the file the filter is working on.  A filter might use this in keyword
361 substitution.  For example:
363 ------------------------
364 [filter "p4"]
365         clean = git-p4-filter --clean %f
366         smudge = git-p4-filter --smudge %f
367 ------------------------
370 Interaction between checkin/checkout attributes
371 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
373 In the check-in codepath, the worktree file is first converted
374 with `filter` driver (if specified and corresponding driver
375 defined), then the result is processed with `ident` (if
376 specified), and then finally with `text` (again, if specified
377 and applicable).
379 In the check-out codepath, the blob content is first converted
380 with `text`, and then `ident` and fed to `filter`.
383 Merging branches with differing checkin/checkout attributes
384 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
386 If you have added attributes to a file that cause the canonical
387 repository format for that file to change, such as adding a
388 clean/smudge filter or text/eol/ident attributes, merging anything
389 where the attribute is not in place would normally cause merge
390 conflicts.
392 To prevent these unnecessary merge conflicts, git can be told to run a
393 virtual check-out and check-in of all three stages of a file when
394 resolving a three-way merge by setting the `merge.renormalize`
395 configuration variable.  This prevents changes caused by check-in
396 conversion from causing spurious merge conflicts when a converted file
397 is merged with an unconverted file.
399 As long as a "smudge->clean" results in the same output as a "clean"
400 even on files that are already smudged, this strategy will
401 automatically resolve all filter-related conflicts.  Filters that do
402 not act in this way may cause additional merge conflicts that must be
403 resolved manually.
406 Generating diff text
407 ~~~~~~~~~~~~~~~~~~~~
409 `diff`
410 ^^^^^^
412 The attribute `diff` affects how 'git' generates diffs for particular
413 files. It can tell git whether to generate a textual patch for the path
414 or to treat the path as a binary file.  It can also affect what line is
415 shown on the hunk header `@@ -k,l +n,m @@` line, tell git to use an
416 external command to generate the diff, or ask git to convert binary
417 files to a text format before generating the diff.
419 Set::
421         A path to which the `diff` attribute is set is treated
422         as text, even when they contain byte values that
423         normally never appear in text files, such as NUL.
425 Unset::
427         A path to which the `diff` attribute is unset will
428         generate `Binary files differ` (or a binary patch, if
429         binary patches are enabled).
431 Unspecified::
433         A path to which the `diff` attribute is unspecified
434         first gets its contents inspected, and if it looks like
435         text, it is treated as text.  Otherwise it would
436         generate `Binary files differ`.
438 String::
440         Diff is shown using the specified diff driver.  Each driver may
441         specify one or more options, as described in the following
442         section. The options for the diff driver "foo" are defined
443         by the configuration variables in the "diff.foo" section of the
444         git config file.
447 Defining an external diff driver
448 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
450 The definition of a diff driver is done in `gitconfig`, not
451 `gitattributes` file, so strictly speaking this manual page is a
452 wrong place to talk about it.  However...
454 To define an external diff driver `jcdiff`, add a section to your
455 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
457 ----------------------------------------------------------------
458 [diff "jcdiff"]
459         command = j-c-diff
460 ----------------------------------------------------------------
462 When git needs to show you a diff for the path with `diff`
463 attribute set to `jcdiff`, it calls the command you specified
464 with the above configuration, i.e. `j-c-diff`, with 7
465 parameters, just like `GIT_EXTERNAL_DIFF` program is called.
466 See linkgit:git[1] for details.
469 Defining a custom hunk-header
470 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
472 Each group of changes (called a "hunk") in the textual diff output
473 is prefixed with a line of the form:
475         @@ -k,l +n,m @@ TEXT
477 This is called a 'hunk header'.  The "TEXT" portion is by default a line
478 that begins with an alphabet, an underscore or a dollar sign; this
479 matches what GNU 'diff -p' output uses.  This default selection however
480 is not suited for some contents, and you can use a customized pattern
481 to make a selection.
483 First, in .gitattributes, you would assign the `diff` attribute
484 for paths.
486 ------------------------
487 *.tex   diff=tex
488 ------------------------
490 Then, you would define a "diff.tex.xfuncname" configuration to
491 specify a regular expression that matches a line that you would
492 want to appear as the hunk header "TEXT". Add a section to your
493 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
495 ------------------------
496 [diff "tex"]
497         xfuncname = "^(\\\\(sub)*section\\{.*)$"
498 ------------------------
500 Note.  A single level of backslashes are eaten by the
501 configuration file parser, so you would need to double the
502 backslashes; the pattern above picks a line that begins with a
503 backslash, and zero or more occurrences of `sub` followed by
504 `section` followed by open brace, to the end of line.
506 There are a few built-in patterns to make this easier, and `tex`
507 is one of them, so you do not have to write the above in your
508 configuration file (you still need to enable this with the
509 attribute mechanism, via `.gitattributes`).  The following built in
510 patterns are available:
512 - `bibtex` suitable for files with BibTeX coded references.
514 - `cpp` suitable for source code in the C and C++ languages.
516 - `csharp` suitable for source code in the C# language.
518 - `fortran` suitable for source code in the Fortran language.
520 - `html` suitable for HTML/XHTML documents.
522 - `java` suitable for source code in the Java language.
524 - `matlab` suitable for source code in the MATLAB language.
526 - `objc` suitable for source code in the Objective-C language.
528 - `pascal` suitable for source code in the Pascal/Delphi language.
530 - `perl` suitable for source code in the Perl language.
532 - `php` suitable for source code in the PHP language.
534 - `python` suitable for source code in the Python language.
536 - `ruby` suitable for source code in the Ruby language.
538 - `tex` suitable for source code for LaTeX documents.
541 Customizing word diff
542 ^^^^^^^^^^^^^^^^^^^^^
544 You can customize the rules that `git diff --word-diff` uses to
545 split words in a line, by specifying an appropriate regular expression
546 in the "diff.*.wordRegex" configuration variable.  For example, in TeX
547 a backslash followed by a sequence of letters forms a command, but
548 several such commands can be run together without intervening
549 whitespace.  To separate them, use a regular expression in your
550 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
552 ------------------------
553 [diff "tex"]
554         wordRegex = "\\\\[a-zA-Z]+|[{}]|\\\\.|[^\\{}[:space:]]+"
555 ------------------------
557 A built-in pattern is provided for all languages listed in the
558 previous section.
561 Performing text diffs of binary files
562 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
564 Sometimes it is desirable to see the diff of a text-converted
565 version of some binary files. For example, a word processor
566 document can be converted to an ASCII text representation, and
567 the diff of the text shown. Even though this conversion loses
568 some information, the resulting diff is useful for human
569 viewing (but cannot be applied directly).
571 The `textconv` config option is used to define a program for
572 performing such a conversion. The program should take a single
573 argument, the name of a file to convert, and produce the
574 resulting text on stdout.
576 For example, to show the diff of the exif information of a
577 file instead of the binary information (assuming you have the
578 exif tool installed), add the following section to your
579 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file):
581 ------------------------
582 [diff "jpg"]
583         textconv = exif
584 ------------------------
586 NOTE: The text conversion is generally a one-way conversion;
587 in this example, we lose the actual image contents and focus
588 just on the text data. This means that diffs generated by
589 textconv are _not_ suitable for applying. For this reason,
590 only `git diff` and the `git log` family of commands (i.e.,
591 log, whatchanged, show) will perform text conversion. `git
592 format-patch` will never generate this output. If you want to
593 send somebody a text-converted diff of a binary file (e.g.,
594 because it quickly conveys the changes you have made), you
595 should generate it separately and send it as a comment _in
596 addition to_ the usual binary diff that you might send.
598 Because text conversion can be slow, especially when doing a
599 large number of them with `git log -p`, git provides a mechanism
600 to cache the output and use it in future diffs.  To enable
601 caching, set the "cachetextconv" variable in your diff driver's
602 config. For example:
604 ------------------------
605 [diff "jpg"]
606         textconv = exif
607         cachetextconv = true
608 ------------------------
610 This will cache the result of running "exif" on each blob
611 indefinitely. If you change the textconv config variable for a
612 diff driver, git will automatically invalidate the cache entries
613 and re-run the textconv filter. If you want to invalidate the
614 cache manually (e.g., because your version of "exif" was updated
615 and now produces better output), you can remove the cache
616 manually with `git update-ref -d refs/notes/textconv/jpg` (where
617 "jpg" is the name of the diff driver, as in the example above).
619 Choosing textconv versus external diff
620 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
622 If you want to show differences between binary or specially-formatted
623 blobs in your repository, you can choose to use either an external diff
624 command, or to use textconv to convert them to a diff-able text format.
625 Which method you choose depends on your exact situation.
627 The advantage of using an external diff command is flexibility. You are
628 not bound to find line-oriented changes, nor is it necessary for the
629 output to resemble unified diff. You are free to locate and report
630 changes in the most appropriate way for your data format.
632 A textconv, by comparison, is much more limiting. You provide a
633 transformation of the data into a line-oriented text format, and git
634 uses its regular diff tools to generate the output. There are several
635 advantages to choosing this method:
637 1. Ease of use. It is often much simpler to write a binary to text
638    transformation than it is to perform your own diff. In many cases,
639    existing programs can be used as textconv filters (e.g., exif,
640    odt2txt).
642 2. Git diff features. By performing only the transformation step
643    yourself, you can still utilize many of git's diff features,
644    including colorization, word-diff, and combined diffs for merges.
646 3. Caching. Textconv caching can speed up repeated diffs, such as those
647    you might trigger by running `git log -p`.
650 Marking files as binary
651 ^^^^^^^^^^^^^^^^^^^^^^^
653 Git usually guesses correctly whether a blob contains text or binary
654 data by examining the beginning of the contents. However, sometimes you
655 may want to override its decision, either because a blob contains binary
656 data later in the file, or because the content, while technically
657 composed of text characters, is opaque to a human reader. For example,
658 many postscript files contain only ascii characters, but produce noisy
659 and meaningless diffs.
661 The simplest way to mark a file as binary is to unset the diff
662 attribute in the `.gitattributes` file:
664 ------------------------
665 *.ps -diff
666 ------------------------
668 This will cause git to generate `Binary files differ` (or a binary
669 patch, if binary patches are enabled) instead of a regular diff.
671 However, one may also want to specify other diff driver attributes. For
672 example, you might want to use `textconv` to convert postscript files to
673 an ascii representation for human viewing, but otherwise treat them as
674 binary files. You cannot specify both `-diff` and `diff=ps` attributes.
675 The solution is to use the `diff.*.binary` config option:
677 ------------------------
678 [diff "ps"]
679   textconv = ps2ascii
680   binary = true
681 ------------------------
683 Performing a three-way merge
684 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
686 `merge`
687 ^^^^^^^
689 The attribute `merge` affects how three versions of a file are
690 merged when a file-level merge is necessary during `git merge`,
691 and other commands such as `git revert` and `git cherry-pick`.
693 Set::
695         Built-in 3-way merge driver is used to merge the
696         contents in a way similar to 'merge' command of `RCS`
697         suite.  This is suitable for ordinary text files.
699 Unset::
701         Take the version from the current branch as the
702         tentative merge result, and declare that the merge has
703         conflicts.  This is suitable for binary files that do
704         not have a well-defined merge semantics.
706 Unspecified::
708         By default, this uses the same built-in 3-way merge
709         driver as is the case when the `merge` attribute is set.
710         However, the `merge.default` configuration variable can name
711         different merge driver to be used with paths for which the
712         `merge` attribute is unspecified.
714 String::
716         3-way merge is performed using the specified custom
717         merge driver.  The built-in 3-way merge driver can be
718         explicitly specified by asking for "text" driver; the
719         built-in "take the current branch" driver can be
720         requested with "binary".
723 Built-in merge drivers
724 ^^^^^^^^^^^^^^^^^^^^^^
726 There are a few built-in low-level merge drivers defined that
727 can be asked for via the `merge` attribute.
729 text::
731         Usual 3-way file level merge for text files.  Conflicted
732         regions are marked with conflict markers `<<<<<<<`,
733         `=======` and `>>>>>>>`.  The version from your branch
734         appears before the `=======` marker, and the version
735         from the merged branch appears after the `=======`
736         marker.
738 binary::
740         Keep the version from your branch in the work tree, but
741         leave the path in the conflicted state for the user to
742         sort out.
744 union::
746         Run 3-way file level merge for text files, but take
747         lines from both versions, instead of leaving conflict
748         markers.  This tends to leave the added lines in the
749         resulting file in random order and the user should
750         verify the result. Do not use this if you do not
751         understand the implications.
754 Defining a custom merge driver
755 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
757 The definition of a merge driver is done in the `.git/config`
758 file, not in the `gitattributes` file, so strictly speaking this
759 manual page is a wrong place to talk about it.  However...
761 To define a custom merge driver `filfre`, add a section to your
762 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
764 ----------------------------------------------------------------
765 [merge "filfre"]
766         name = feel-free merge driver
767         driver = filfre %O %A %B
768         recursive = binary
769 ----------------------------------------------------------------
771 The `merge.*.name` variable gives the driver a human-readable
772 name.
774 The `merge.*.driver` variable's value is used to construct a
775 command to run to merge ancestor's version (`%O`), current
776 version (`%A`) and the other branches' version (`%B`).  These
777 three tokens are replaced with the names of temporary files that
778 hold the contents of these versions when the command line is
779 built. Additionally, %L will be replaced with the conflict marker
780 size (see below).
782 The merge driver is expected to leave the result of the merge in
783 the file named with `%A` by overwriting it, and exit with zero
784 status if it managed to merge them cleanly, or non-zero if there
785 were conflicts.
787 The `merge.*.recursive` variable specifies what other merge
788 driver to use when the merge driver is called for an internal
789 merge between common ancestors, when there are more than one.
790 When left unspecified, the driver itself is used for both
791 internal merge and the final merge.
794 `conflict-marker-size`
795 ^^^^^^^^^^^^^^^^^^^^^^
797 This attribute controls the length of conflict markers left in
798 the work tree file during a conflicted merge.  Only setting to
799 the value to a positive integer has any meaningful effect.
801 For example, this line in `.gitattributes` can be used to tell the merge
802 machinery to leave much longer (instead of the usual 7-character-long)
803 conflict markers when merging the file `Documentation/git-merge.txt`
804 results in a conflict.
806 ------------------------
807 Documentation/git-merge.txt     conflict-marker-size=32
808 ------------------------
811 Checking whitespace errors
812 ~~~~~~~~~~~~~~~~~~~~~~~~~~
814 `whitespace`
815 ^^^^^^^^^^^^
817 The `core.whitespace` configuration variable allows you to define what
818 'diff' and 'apply' should consider whitespace errors for all paths in
819 the project (See linkgit:git-config[1]).  This attribute gives you finer
820 control per path.
822 Set::
824         Notice all types of potential whitespace errors known to git.
825         The tab width is taken from the value of the `core.whitespace`
826         configuration variable.
828 Unset::
830         Do not notice anything as error.
832 Unspecified::
834         Use the value of the `core.whitespace` configuration variable to
835         decide what to notice as error.
837 String::
839         Specify a comma separate list of common whitespace problems to
840         notice in the same format as the `core.whitespace` configuration
841         variable.
844 Creating an archive
845 ~~~~~~~~~~~~~~~~~~~
847 `export-ignore`
848 ^^^^^^^^^^^^^^^
850 Files and directories with the attribute `export-ignore` won't be added to
851 archive files.
853 `export-subst`
854 ^^^^^^^^^^^^^^
856 If the attribute `export-subst` is set for a file then git will expand
857 several placeholders when adding this file to an archive.  The
858 expansion depends on the availability of a commit ID, i.e., if
859 linkgit:git-archive[1] has been given a tree instead of a commit or a
860 tag then no replacement will be done.  The placeholders are the same
861 as those for the option `--pretty=format:` of linkgit:git-log[1],
862 except that they need to be wrapped like this: `$Format:PLACEHOLDERS$`
863 in the file.  E.g. the string `$Format:%H$` will be replaced by the
864 commit hash.
867 Packing objects
868 ~~~~~~~~~~~~~~~
870 `delta`
871 ^^^^^^^
873 Delta compression will not be attempted for blobs for paths with the
874 attribute `delta` set to false.
877 Viewing files in GUI tools
878 ~~~~~~~~~~~~~~~~~~~~~~~~~~
880 `encoding`
881 ^^^^^^^^^^
883 The value of this attribute specifies the character encoding that should
884 be used by GUI tools (e.g. linkgit:gitk[1] and linkgit:git-gui[1]) to
885 display the contents of the relevant file. Note that due to performance
886 considerations linkgit:gitk[1] does not use this attribute unless you
887 manually enable per-file encodings in its options.
889 If this attribute is not set or has an invalid value, the value of the
890 `gui.encoding` configuration variable is used instead
891 (See linkgit:git-config[1]).
894 USING MACRO ATTRIBUTES
895 ----------------------
897 You do not want any end-of-line conversions applied to, nor textual diffs
898 produced for, any binary file you track.  You would need to specify e.g.
900 ------------
901 *.jpg -text -diff
902 ------------
904 but that may become cumbersome, when you have many attributes.  Using
905 macro attributes, you can define an attribute that, when set, also
906 sets or unsets a number of other attributes at the same time.  The
907 system knows a built-in macro attribute, `binary`:
909 ------------
910 *.jpg binary
911 ------------
913 Setting the "binary" attribute also unsets the "text" and "diff"
914 attributes as above.  Note that macro attributes can only be "Set",
915 though setting one might have the effect of setting or unsetting other
916 attributes or even returning other attributes to the "Unspecified"
917 state.
920 DEFINING MACRO ATTRIBUTES
921 -------------------------
923 Custom macro attributes can be defined only in the `.gitattributes`
924 file at the toplevel (i.e. not in any subdirectory).  The built-in
925 macro attribute "binary" is equivalent to:
927 ------------
928 [attr]binary -diff -text
929 ------------
932 EXAMPLE
933 -------
935 If you have these three `gitattributes` file:
937 ----------------------------------------------------------------
938 (in $GIT_DIR/info/attributes)
940 a*      foo !bar -baz
942 (in .gitattributes)
943 abc     foo bar baz
945 (in t/.gitattributes)
946 ab*     merge=filfre
947 abc     -foo -bar
948 *.c     frotz
949 ----------------------------------------------------------------
951 the attributes given to path `t/abc` are computed as follows:
953 1. By examining `t/.gitattributes` (which is in the same
954    directory as the path in question), git finds that the first
955    line matches.  `merge` attribute is set.  It also finds that
956    the second line matches, and attributes `foo` and `bar`
957    are unset.
959 2. Then it examines `.gitattributes` (which is in the parent
960    directory), and finds that the first line matches, but
961    `t/.gitattributes` file already decided how `merge`, `foo`
962    and `bar` attributes should be given to this path, so it
963    leaves `foo` and `bar` unset.  Attribute `baz` is set.
965 3. Finally it examines `$GIT_DIR/info/attributes`.  This file
966    is used to override the in-tree settings.  The first line is
967    a match, and `foo` is set, `bar` is reverted to unspecified
968    state, and `baz` is unset.
970 As the result, the attributes assignment to `t/abc` becomes:
972 ----------------------------------------------------------------
973 foo     set to true
974 bar     unspecified
975 baz     set to false
976 merge   set to string value "filfre"
977 frotz   unspecified
978 ----------------------------------------------------------------
981 SEE ALSO
982 --------
983 linkgit:git-check-attr[1].
987 Part of the linkgit:git[1] suite