set_git_dir: handle feeding gitdir to itself
[git.git] / Documentation / gitattributes.txt
1 gitattributes(5)
2 ================
5 ----
6 gitattributes - defining attributes per path
9 --------
10 $GIT_DIR/info/attributes, .gitattributes
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. Leading and trailing whitespaces are
25 ignored. Lines that begin with '#' are ignored. Patterns
26 that begin with a double quote are quoted in C style.
27 When the pattern matches the path in question, the attributes
28 listed on the line are given to the path.
30 Each attribute can be in one of these states for a given path:
32 Set::
34         The path has the attribute with special value "true";
35         this is specified by listing only the name of the
36         attribute in the attribute list.
38 Unset::
40         The path has the attribute with special value "false";
41         this is specified by listing the name of the attribute
42         prefixed with a dash `-` in the attribute list.
44 Set to a value::
46         The path has the attribute with specified string value;
47         this is specified by listing the name of the attribute
48         followed by an equal sign `=` and its value in the
49         attribute list.
51 Unspecified::
53         No pattern matches the path, and nothing says if
54         the path has or does not have the attribute, the
55         attribute for the path is said to be Unspecified.
57 When more than one pattern matches the path, a later line
58 overrides an earlier line.  This overriding is done per
59 attribute.  The rules how the pattern matches paths are the
60 same as in `.gitignore` files; see linkgit:gitignore[5].
61 Unlike `.gitignore`, negative patterns are forbidden.
63 When deciding what attributes are assigned to a path, Git
64 consults `$GIT_DIR/info/attributes` file (which has the highest
65 precedence), `.gitattributes` file in the same directory as the
66 path in question, and its parent directories up to the toplevel of the
67 work tree (the further the directory that contains `.gitattributes`
68 is from the path in question, the lower its precedence). Finally
69 global and system-wide files are considered (they have the lowest
70 precedence).
72 When the `.gitattributes` file is missing from the work tree, the
73 path in the index is used as a fall-back.  During checkout process,
74 `.gitattributes` in the index is used and then the file in the
75 working tree is used as a fall-back.
77 If you wish to affect only a single repository (i.e., to assign
78 attributes to files that are particular to
79 one user's workflow for that repository), then
80 attributes should be placed in the `$GIT_DIR/info/attributes` file.
81 Attributes which should be version-controlled and distributed to other
82 repositories (i.e., attributes of interest to all users) should go into
83 `.gitattributes` files. Attributes that should affect all repositories
84 for a single user should be placed in a file specified by the
85 `core.attributesFile` configuration option (see linkgit:git-config[1]).
86 Its default value is $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME
87 is either not set or empty, $HOME/.config/git/attributes is used instead.
88 Attributes for all users on a system should be placed in the
89 `$(prefix)/etc/gitattributes` file.
91 Sometimes you would need to override a setting of an attribute
92 for a path to `Unspecified` state.  This can be done by listing
93 the name of the attribute prefixed with an exclamation point `!`.
97 -------
99 Certain operations by Git can be influenced by assigning
100 particular attributes to a path.  Currently, the following
101 operations are attributes-aware.
103 Checking-out and checking-in
104 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106 These attributes affect how the contents stored in the
107 repository are copied to the working tree files when commands
108 such as 'git checkout' and 'git merge' run.  They also affect how
109 Git stores the contents you prepare in the working tree in the
110 repository upon 'git add' and 'git commit'.
112 `text`
113 ^^^^^^
115 This attribute enables and controls end-of-line normalization.  When a
116 text file is normalized, its line endings are converted to LF in the
117 repository.  To control what line ending style is used in the working
118 directory, use the `eol` attribute for a single file and the
119 `core.eol` configuration variable for all text files.
120 Note that `core.autocrlf` overrides `core.eol`
122 Set::
124         Setting the `text` attribute on a path enables end-of-line
125         normalization and marks the path as a text file.  End-of-line
126         conversion takes place without guessing the content type.
128 Unset::
130         Unsetting the `text` attribute on a path tells Git not to
131         attempt any end-of-line conversion upon checkin or checkout.
133 Set to string value "auto"::
135         When `text` is set to "auto", the path is marked for automatic
136         end-of-line conversion.  If Git decides that the content is
137         text, its line endings are converted to LF on checkin.
138         When the file has been committed with CRLF, no conversion is done.
140 Unspecified::
142         If the `text` attribute is unspecified, Git uses the
143         `core.autocrlf` configuration variable to determine if the
144         file should be converted.
146 Any other value causes Git to act as if `text` has been left
147 unspecified.
149 `eol`
150 ^^^^^
152 This attribute sets a specific line-ending style to be used in the
153 working directory.  It enables end-of-line conversion without any
154 content checks, effectively setting the `text` attribute.
156 Set to string value "crlf"::
158         This setting forces Git to normalize line endings for this
159         file on checkin and convert them to CRLF when the file is
160         checked out.
162 Set to string value "lf"::
164         This setting forces Git to normalize line endings to LF on
165         checkin and prevents conversion to CRLF when the file is
166         checked out.
168 Backwards compatibility with `crlf` attribute
169 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
171 For backwards compatibility, the `crlf` attribute is interpreted as
172 follows:
174 ------------------------
175 crlf            text
176 -crlf           -text
177 crlf=input      eol=lf
178 ------------------------
180 End-of-line conversion
181 ^^^^^^^^^^^^^^^^^^^^^^
183 While Git normally leaves file contents alone, it can be configured to
184 normalize line endings to LF in the repository and, optionally, to
185 convert them to CRLF when files are checked out.
187 If you simply want to have CRLF line endings in your working directory
188 regardless of the repository you are working with, you can set the
189 config variable "core.autocrlf" without using any attributes.
191 ------------------------
192 [core]
193         autocrlf = true
194 ------------------------
196 This does not force normalization of text files, but does ensure
197 that text files that you introduce to the repository have their line
198 endings normalized to LF when they are added, and that files that are
199 already normalized in the repository stay normalized.
201 If you want to ensure that text files that any contributor introduces to
202 the repository have their line endings normalized, you can set the
203 `text` attribute to "auto" for _all_ files.
205 ------------------------
206 *       text=auto
207 ------------------------
209 The attributes allow a fine-grained control, how the line endings
210 are converted.
211 Here is an example that will make Git normalize .txt, .vcproj and .sh
212 files, ensure that .vcproj files have CRLF and .sh files have LF in
213 the working directory, and prevent .jpg files from being normalized
214 regardless of their content.
216 ------------------------
217 *               text=auto
218 *.txt           text
219 *.vcproj        text eol=crlf
220 *.sh            text eol=lf
221 *.jpg           -text
222 ------------------------
224 NOTE: When `text=auto` conversion is enabled in a cross-platform
225 project using push and pull to a central repository the text files
226 containing CRLFs should be normalized.
228 From a clean working directory:
230 -------------------------------------------------
231 $ echo "* text=auto" >.gitattributes
232 $ git read-tree --empty   # Clean index, force re-scan of working directory
233 $ git add .
234 $ git status        # Show files that will be normalized
235 $ git commit -m "Introduce end-of-line normalization"
236 -------------------------------------------------
238 If any files that should not be normalized show up in 'git status',
239 unset their `text` attribute before running 'git add -u'.
241 ------------------------
242 manual.pdf      -text
243 ------------------------
245 Conversely, text files that Git does not detect can have normalization
246 enabled manually.
248 ------------------------
249 weirdchars.txt  text
250 ------------------------
252 If `core.safecrlf` is set to "true" or "warn", Git verifies if
253 the conversion is reversible for the current setting of
254 `core.autocrlf`.  For "true", Git rejects irreversible
255 conversions; for "warn", Git only prints a warning but accepts
256 an irreversible conversion.  The safety triggers to prevent such
257 a conversion done to the files in the work tree, but there are a
258 few exceptions.  Even though...
260 - 'git add' itself does not touch the files in the work tree, the
261   next checkout would, so the safety triggers;
263 - 'git apply' to update a text file with a patch does touch the files
264   in the work tree, but the operation is about text files and CRLF
265   conversion is about fixing the line ending inconsistencies, so the
266   safety does not trigger;
268 - 'git diff' itself does not touch the files in the work tree, it is
269   often run to inspect the changes you intend to next 'git add'.  To
270   catch potential problems early, safety triggers.
273 `ident`
274 ^^^^^^^
276 When the attribute `ident` is set for a path, Git replaces
277 `$Id$` in the blob object with `$Id:`, followed by the
278 40-character hexadecimal blob object name, followed by a dollar
279 sign `$` upon checkout.  Any byte sequence that begins with
280 `$Id:` and ends with `$` in the worktree file is replaced
281 with `$Id$` upon check-in.
284 `filter`
285 ^^^^^^^^
287 A `filter` attribute can be set to a string value that names a
288 filter driver specified in the configuration.
290 A filter driver consists of a `clean` command and a `smudge`
291 command, either of which can be left unspecified.  Upon
292 checkout, when the `smudge` command is specified, the command is
293 fed the blob object from its standard input, and its standard
294 output is used to update the worktree file.  Similarly, the
295 `clean` command is used to convert the contents of worktree file
296 upon checkin. By default these commands process only a single
297 blob and terminate. If a long running `process` filter is used
298 in place of `clean` and/or `smudge` filters, then Git can process
299 all blobs with a single filter command invocation for the entire
300 life of a single Git command, for example `git add --all`. If a
301 long running `process` filter is configured then it always takes
302 precedence over a configured single blob filter. See section
303 below for the description of the protocol used to communicate with
304 a `process` filter.
306 One use of the content filtering is to massage the content into a shape
307 that is more convenient for the platform, filesystem, and the user to use.
308 For this mode of operation, the key phrase here is "more convenient" and
309 not "turning something unusable into usable".  In other words, the intent
310 is that if someone unsets the filter driver definition, or does not have
311 the appropriate filter program, the project should still be usable.
313 Another use of the content filtering is to store the content that cannot
314 be directly used in the repository (e.g. a UUID that refers to the true
315 content stored outside Git, or an encrypted content) and turn it into a
316 usable form upon checkout (e.g. download the external content, or decrypt
317 the encrypted content).
319 These two filters behave differently, and by default, a filter is taken as
320 the former, massaging the contents into more convenient shape.  A missing
321 filter driver definition in the config, or a filter driver that exits with
322 a non-zero status, is not an error but makes the filter a no-op passthru.
324 You can declare that a filter turns a content that by itself is unusable
325 into a usable content by setting the filter.<driver>.required configuration
326 variable to `true`.
328 For example, in .gitattributes, you would assign the `filter`
329 attribute for paths.
331 ------------------------
332 *.c     filter=indent
333 ------------------------
335 Then you would define a "filter.indent.clean" and "filter.indent.smudge"
336 configuration in your .git/config to specify a pair of commands to
337 modify the contents of C programs when the source files are checked
338 in ("clean" is run) and checked out (no change is made because the
339 command is "cat").
341 ------------------------
342 [filter "indent"]
343         clean = indent
344         smudge = cat
345 ------------------------
347 For best results, `clean` should not alter its output further if it is
348 run twice ("clean->clean" should be equivalent to "clean"), and
349 multiple `smudge` commands should not alter `clean`'s output
350 ("smudge->smudge->clean" should be equivalent to "clean").  See the
351 section on merging below.
353 The "indent" filter is well-behaved in this regard: it will not modify
354 input that is already correctly indented.  In this case, the lack of a
355 smudge filter means that the clean filter _must_ accept its own output
356 without modifying it.
358 If a filter _must_ succeed in order to make the stored contents usable,
359 you can declare that the filter is `required`, in the configuration:
361 ------------------------
362 [filter "crypt"]
363         clean = openssl enc ...
364         smudge = openssl enc -d ...
365         required
366 ------------------------
368 Sequence "%f" on the filter command line is replaced with the name of
369 the file the filter is working on.  A filter might use this in keyword
370 substitution.  For example:
372 ------------------------
373 [filter "p4"]
374         clean = git-p4-filter --clean %f
375         smudge = git-p4-filter --smudge %f
376 ------------------------
378 Note that "%f" is the name of the path that is being worked on. Depending
379 on the version that is being filtered, the corresponding file on disk may
380 not exist, or may have different contents. So, smudge and clean commands
381 should not try to access the file on disk, but only act as filters on the
382 content provided to them on standard input.
384 Long Running Filter Process
385 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
387 If the filter command (a string value) is defined via
388 `filter.<driver>.process` then Git can process all blobs with a
389 single filter invocation for the entire life of a single Git
390 command. This is achieved by using a packet format (pkt-line,
391 see technical/protocol-common.txt) based protocol over standard
392 input and standard output as follows. All packets, except for the
393 "*CONTENT" packets and the "0000" flush packet, are considered
394 text and therefore are terminated by a LF.
396 Git starts the filter when it encounters the first file
397 that needs to be cleaned or smudged. After the filter started
398 Git sends a welcome message ("git-filter-client"), a list of supported
399 protocol version numbers, and a flush packet. Git expects to read a welcome
400 response message ("git-filter-server"), exactly one protocol version number
401 from the previously sent list, and a flush packet. All further
402 communication will be based on the selected version. The remaining
403 protocol description below documents "version=2". Please note that
404 "version=42" in the example below does not exist and is only there
405 to illustrate how the protocol would look like with more than one
406 version.
408 After the version negotiation Git sends a list of all capabilities that
409 it supports and a flush packet. Git expects to read a list of desired
410 capabilities, which must be a subset of the supported capabilities list,
411 and a flush packet as response:
412 ------------------------
413 packet:          git> git-filter-client
414 packet:          git> version=2
415 packet:          git> version=42
416 packet:          git> 0000
417 packet:          git< git-filter-server
418 packet:          git< version=2
419 packet:          git< 0000
420 packet:          git> capability=clean
421 packet:          git> capability=smudge
422 packet:          git> capability=not-yet-invented
423 packet:          git> 0000
424 packet:          git< capability=clean
425 packet:          git< capability=smudge
426 packet:          git< 0000
427 ------------------------
428 Supported filter capabilities in version 2 are "clean", "smudge",
429 and "delay".
431 Afterwards Git sends a list of "key=value" pairs terminated with
432 a flush packet. The list will contain at least the filter command
433 (based on the supported capabilities) and the pathname of the file
434 to filter relative to the repository root. Right after the flush packet
435 Git sends the content split in zero or more pkt-line packets and a
436 flush packet to terminate content. Please note, that the filter
437 must not send any response before it received the content and the
438 final flush packet. Also note that the "value" of a "key=value" pair
439 can contain the "=" character whereas the key would never contain
440 that character.
441 ------------------------
442 packet:          git> command=smudge
443 packet:          git> pathname=path/testfile.dat
444 packet:          git> 0000
445 packet:          git> CONTENT
446 packet:          git> 0000
447 ------------------------
449 The filter is expected to respond with a list of "key=value" pairs
450 terminated with a flush packet. If the filter does not experience
451 problems then the list must contain a "success" status. Right after
452 these packets the filter is expected to send the content in zero
453 or more pkt-line packets and a flush packet at the end. Finally, a
454 second list of "key=value" pairs terminated with a flush packet
455 is expected. The filter can change the status in the second list
456 or keep the status as is with an empty list. Please note that the
457 empty list must be terminated with a flush packet regardless.
459 ------------------------
460 packet:          git< status=success
461 packet:          git< 0000
462 packet:          git< SMUDGED_CONTENT
463 packet:          git< 0000
464 packet:          git< 0000  # empty list, keep "status=success" unchanged!
465 ------------------------
467 If the result content is empty then the filter is expected to respond
468 with a "success" status and a flush packet to signal the empty content.
469 ------------------------
470 packet:          git< status=success
471 packet:          git< 0000
472 packet:          git< 0000  # empty content!
473 packet:          git< 0000  # empty list, keep "status=success" unchanged!
474 ------------------------
476 In case the filter cannot or does not want to process the content,
477 it is expected to respond with an "error" status.
478 ------------------------
479 packet:          git< status=error
480 packet:          git< 0000
481 ------------------------
483 If the filter experiences an error during processing, then it can
484 send the status "error" after the content was (partially or
485 completely) sent.
486 ------------------------
487 packet:          git< status=success
488 packet:          git< 0000
489 packet:          git< HALF_WRITTEN_ERRONEOUS_CONTENT
490 packet:          git< 0000
491 packet:          git< status=error
492 packet:          git< 0000
493 ------------------------
495 In case the filter cannot or does not want to process the content
496 as well as any future content for the lifetime of the Git process,
497 then it is expected to respond with an "abort" status at any point
498 in the protocol.
499 ------------------------
500 packet:          git< status=abort
501 packet:          git< 0000
502 ------------------------
504 Git neither stops nor restarts the filter process in case the
505 "error"/"abort" status is set. However, Git sets its exit code
506 according to the `filter.<driver>.required` flag, mimicking the
507 behavior of the `filter.<driver>.clean` / `filter.<driver>.smudge`
508 mechanism.
510 If the filter dies during the communication or does not adhere to
511 the protocol then Git will stop the filter process and restart it
512 with the next file that needs to be processed. Depending on the
513 `filter.<driver>.required` flag Git will interpret that as error.
515 After the filter has processed a command it is expected to wait for
516 a "key=value" list containing the next command. Git will close
517 the command pipe on exit. The filter is expected to detect EOF
518 and exit gracefully on its own. Git will wait until the filter
519 process has stopped.
521 Delay
522 ^^^^^
524 If the filter supports the "delay" capability, then Git can send the
525 flag "can-delay" after the filter command and pathname. This flag
526 denotes that the filter can delay filtering the current blob (e.g. to
527 compensate network latencies) by responding with no content but with
528 the status "delayed" and a flush packet.
529 ------------------------
530 packet:          git> command=smudge
531 packet:          git> pathname=path/testfile.dat
532 packet:          git> can-delay=1
533 packet:          git> 0000
534 packet:          git> CONTENT
535 packet:          git> 0000
536 packet:          git< status=delayed
537 packet:          git< 0000
538 ------------------------
540 If the filter supports the "delay" capability then it must support the
541 "list_available_blobs" command. If Git sends this command, then the
542 filter is expected to return a list of pathnames representing blobs
543 that have been delayed earlier and are now available.
544 The list must be terminated with a flush packet followed
545 by a "success" status that is also terminated with a flush packet. If
546 no blobs for the delayed paths are available, yet, then the filter is
547 expected to block the response until at least one blob becomes
548 available. The filter can tell Git that it has no more delayed blobs
549 by sending an empty list. As soon as the filter responds with an empty
550 list, Git stops asking. All blobs that Git has not received at this
551 point are considered missing and will result in an error.
553 ------------------------
554 packet:          git> command=list_available_blobs
555 packet:          git> 0000
556 packet:          git< pathname=path/testfile.dat
557 packet:          git< pathname=path/otherfile.dat
558 packet:          git< 0000
559 packet:          git< status=success
560 packet:          git< 0000
561 ------------------------
563 After Git received the pathnames, it will request the corresponding
564 blobs again. These requests contain a pathname and an empty content
565 section. The filter is expected to respond with the smudged content
566 in the usual way as explained above.
567 ------------------------
568 packet:          git> command=smudge
569 packet:          git> pathname=path/testfile.dat
570 packet:          git> 0000
571 packet:          git> 0000  # empty content!
572 packet:          git< status=success
573 packet:          git< 0000
574 packet:          git< SMUDGED_CONTENT
575 packet:          git< 0000
576 packet:          git< 0000  # empty list, keep "status=success" unchanged!
577 ------------------------
579 Example
580 ^^^^^^^
582 A long running filter demo implementation can be found in
583 `contrib/long-running-filter/` located in the Git
584 core repository. If you develop your own long running filter
585 process then the `GIT_TRACE_PACKET` environment variables can be
586 very helpful for debugging (see linkgit:git[1]).
588 Please note that you cannot use an existing `filter.<driver>.clean`
589 or `filter.<driver>.smudge` command with `filter.<driver>.process`
590 because the former two use a different inter process communication
591 protocol than the latter one.
594 Interaction between checkin/checkout attributes
595 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
597 In the check-in codepath, the worktree file is first converted
598 with `filter` driver (if specified and corresponding driver
599 defined), then the result is processed with `ident` (if
600 specified), and then finally with `text` (again, if specified
601 and applicable).
603 In the check-out codepath, the blob content is first converted
604 with `text`, and then `ident` and fed to `filter`.
607 Merging branches with differing checkin/checkout attributes
608 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
610 If you have added attributes to a file that cause the canonical
611 repository format for that file to change, such as adding a
612 clean/smudge filter or text/eol/ident attributes, merging anything
613 where the attribute is not in place would normally cause merge
614 conflicts.
616 To prevent these unnecessary merge conflicts, Git can be told to run a
617 virtual check-out and check-in of all three stages of a file when
618 resolving a three-way merge by setting the `merge.renormalize`
619 configuration variable.  This prevents changes caused by check-in
620 conversion from causing spurious merge conflicts when a converted file
621 is merged with an unconverted file.
623 As long as a "smudge->clean" results in the same output as a "clean"
624 even on files that are already smudged, this strategy will
625 automatically resolve all filter-related conflicts.  Filters that do
626 not act in this way may cause additional merge conflicts that must be
627 resolved manually.
630 Generating diff text
631 ~~~~~~~~~~~~~~~~~~~~
633 `diff`
634 ^^^^^^
636 The attribute `diff` affects how Git generates diffs for particular
637 files. It can tell Git whether to generate a textual patch for the path
638 or to treat the path as a binary file.  It can also affect what line is
639 shown on the hunk header `@@ -k,l +n,m @@` line, tell Git to use an
640 external command to generate the diff, or ask Git to convert binary
641 files to a text format before generating the diff.
643 Set::
645         A path to which the `diff` attribute is set is treated
646         as text, even when they contain byte values that
647         normally never appear in text files, such as NUL.
649 Unset::
651         A path to which the `diff` attribute is unset will
652         generate `Binary files differ` (or a binary patch, if
653         binary patches are enabled).
655 Unspecified::
657         A path to which the `diff` attribute is unspecified
658         first gets its contents inspected, and if it looks like
659         text and is smaller than core.bigFileThreshold, it is treated
660         as text. Otherwise it would generate `Binary files differ`.
662 String::
664         Diff is shown using the specified diff driver.  Each driver may
665         specify one or more options, as described in the following
666         section. The options for the diff driver "foo" are defined
667         by the configuration variables in the "" section of the
668         Git config file.
671 Defining an external diff driver
672 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
674 The definition of a diff driver is done in `gitconfig`, not
675 `gitattributes` file, so strictly speaking this manual page is a
676 wrong place to talk about it.  However...
678 To define an external diff driver `jcdiff`, add a section to your
679 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
681 ----------------------------------------------------------------
682 [diff "jcdiff"]
683         command = j-c-diff
684 ----------------------------------------------------------------
686 When Git needs to show you a diff for the path with `diff`
687 attribute set to `jcdiff`, it calls the command you specified
688 with the above configuration, i.e. `j-c-diff`, with 7
689 parameters, just like `GIT_EXTERNAL_DIFF` program is called.
690 See linkgit:git[1] for details.
693 Defining a custom hunk-header
694 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
696 Each group of changes (called a "hunk") in the textual diff output
697 is prefixed with a line of the form:
699         @@ -k,l +n,m @@ TEXT
701 This is called a 'hunk header'.  The "TEXT" portion is by default a line
702 that begins with an alphabet, an underscore or a dollar sign; this
703 matches what GNU 'diff -p' output uses.  This default selection however
704 is not suited for some contents, and you can use a customized pattern
705 to make a selection.
707 First, in .gitattributes, you would assign the `diff` attribute
708 for paths.
710 ------------------------
711 *.tex   diff=tex
712 ------------------------
714 Then, you would define a "diff.tex.xfuncname" configuration to
715 specify a regular expression that matches a line that you would
716 want to appear as the hunk header "TEXT". Add a section to your
717 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
719 ------------------------
720 [diff "tex"]
721         xfuncname = "^(\\\\(sub)*section\\{.*)$"
722 ------------------------
724 Note.  A single level of backslashes are eaten by the
725 configuration file parser, so you would need to double the
726 backslashes; the pattern above picks a line that begins with a
727 backslash, and zero or more occurrences of `sub` followed by
728 `section` followed by open brace, to the end of line.
730 There are a few built-in patterns to make this easier, and `tex`
731 is one of them, so you do not have to write the above in your
732 configuration file (you still need to enable this with the
733 attribute mechanism, via `.gitattributes`).  The following built in
734 patterns are available:
736 - `ada` suitable for source code in the Ada language.
738 - `bibtex` suitable for files with BibTeX coded references.
740 - `cpp` suitable for source code in the C and C++ languages.
742 - `csharp` suitable for source code in the C# language.
744 - `css` suitable for cascading style sheets.
746 - `fortran` suitable for source code in the Fortran language.
748 - `fountain` suitable for Fountain documents.
750 - `html` suitable for HTML/XHTML documents.
752 - `java` suitable for source code in the Java language.
754 - `matlab` suitable for source code in the MATLAB language.
756 - `objc` suitable for source code in the Objective-C language.
758 - `pascal` suitable for source code in the Pascal/Delphi language.
760 - `perl` suitable for source code in the Perl language.
762 - `php` suitable for source code in the PHP language.
764 - `python` suitable for source code in the Python language.
766 - `ruby` suitable for source code in the Ruby language.
768 - `tex` suitable for source code for LaTeX documents.
771 Customizing word diff
772 ^^^^^^^^^^^^^^^^^^^^^
774 You can customize the rules that `git diff --word-diff` uses to
775 split words in a line, by specifying an appropriate regular expression
776 in the "diff.*.wordRegex" configuration variable.  For example, in TeX
777 a backslash followed by a sequence of letters forms a command, but
778 several such commands can be run together without intervening
779 whitespace.  To separate them, use a regular expression in your
780 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
782 ------------------------
783 [diff "tex"]
784         wordRegex = "\\\\[a-zA-Z]+|[{}]|\\\\.|[^\\{}[:space:]]+"
785 ------------------------
787 A built-in pattern is provided for all languages listed in the
788 previous section.
791 Performing text diffs of binary files
792 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
794 Sometimes it is desirable to see the diff of a text-converted
795 version of some binary files. For example, a word processor
796 document can be converted to an ASCII text representation, and
797 the diff of the text shown. Even though this conversion loses
798 some information, the resulting diff is useful for human
799 viewing (but cannot be applied directly).
801 The `textconv` config option is used to define a program for
802 performing such a conversion. The program should take a single
803 argument, the name of a file to convert, and produce the
804 resulting text on stdout.
806 For example, to show the diff of the exif information of a
807 file instead of the binary information (assuming you have the
808 exif tool installed), add the following section to your
809 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file):
811 ------------------------
812 [diff "jpg"]
813         textconv = exif
814 ------------------------
816 NOTE: The text conversion is generally a one-way conversion;
817 in this example, we lose the actual image contents and focus
818 just on the text data. This means that diffs generated by
819 textconv are _not_ suitable for applying. For this reason,
820 only `git diff` and the `git log` family of commands (i.e.,
821 log, whatchanged, show) will perform text conversion. `git
822 format-patch` will never generate this output. If you want to
823 send somebody a text-converted diff of a binary file (e.g.,
824 because it quickly conveys the changes you have made), you
825 should generate it separately and send it as a comment _in
826 addition to_ the usual binary diff that you might send.
828 Because text conversion can be slow, especially when doing a
829 large number of them with `git log -p`, Git provides a mechanism
830 to cache the output and use it in future diffs.  To enable
831 caching, set the "cachetextconv" variable in your diff driver's
832 config. For example:
834 ------------------------
835 [diff "jpg"]
836         textconv = exif
837         cachetextconv = true
838 ------------------------
840 This will cache the result of running "exif" on each blob
841 indefinitely. If you change the textconv config variable for a
842 diff driver, Git will automatically invalidate the cache entries
843 and re-run the textconv filter. If you want to invalidate the
844 cache manually (e.g., because your version of "exif" was updated
845 and now produces better output), you can remove the cache
846 manually with `git update-ref -d refs/notes/textconv/jpg` (where
847 "jpg" is the name of the diff driver, as in the example above).
849 Choosing textconv versus external diff
850 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
852 If you want to show differences between binary or specially-formatted
853 blobs in your repository, you can choose to use either an external diff
854 command, or to use textconv to convert them to a diff-able text format.
855 Which method you choose depends on your exact situation.
857 The advantage of using an external diff command is flexibility. You are
858 not bound to find line-oriented changes, nor is it necessary for the
859 output to resemble unified diff. You are free to locate and report
860 changes in the most appropriate way for your data format.
862 A textconv, by comparison, is much more limiting. You provide a
863 transformation of the data into a line-oriented text format, and Git
864 uses its regular diff tools to generate the output. There are several
865 advantages to choosing this method:
867 1. Ease of use. It is often much simpler to write a binary to text
868    transformation than it is to perform your own diff. In many cases,
869    existing programs can be used as textconv filters (e.g., exif,
870    odt2txt).
872 2. Git diff features. By performing only the transformation step
873    yourself, you can still utilize many of Git's diff features,
874    including colorization, word-diff, and combined diffs for merges.
876 3. Caching. Textconv caching can speed up repeated diffs, such as those
877    you might trigger by running `git log -p`.
880 Marking files as binary
881 ^^^^^^^^^^^^^^^^^^^^^^^
883 Git usually guesses correctly whether a blob contains text or binary
884 data by examining the beginning of the contents. However, sometimes you
885 may want to override its decision, either because a blob contains binary
886 data later in the file, or because the content, while technically
887 composed of text characters, is opaque to a human reader. For example,
888 many postscript files contain only ASCII characters, but produce noisy
889 and meaningless diffs.
891 The simplest way to mark a file as binary is to unset the diff
892 attribute in the `.gitattributes` file:
894 ------------------------
895 *.ps -diff
896 ------------------------
898 This will cause Git to generate `Binary files differ` (or a binary
899 patch, if binary patches are enabled) instead of a regular diff.
901 However, one may also want to specify other diff driver attributes. For
902 example, you might want to use `textconv` to convert postscript files to
903 an ASCII representation for human viewing, but otherwise treat them as
904 binary files. You cannot specify both `-diff` and `diff=ps` attributes.
905 The solution is to use the `diff.*.binary` config option:
907 ------------------------
908 [diff "ps"]
909   textconv = ps2ascii
910   binary = true
911 ------------------------
913 Performing a three-way merge
914 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
916 `merge`
917 ^^^^^^^
919 The attribute `merge` affects how three versions of a file are
920 merged when a file-level merge is necessary during `git merge`,
921 and other commands such as `git revert` and `git cherry-pick`.
923 Set::
925         Built-in 3-way merge driver is used to merge the
926         contents in a way similar to 'merge' command of `RCS`
927         suite.  This is suitable for ordinary text files.
929 Unset::
931         Take the version from the current branch as the
932         tentative merge result, and declare that the merge has
933         conflicts.  This is suitable for binary files that do
934         not have a well-defined merge semantics.
936 Unspecified::
938         By default, this uses the same built-in 3-way merge
939         driver as is the case when the `merge` attribute is set.
940         However, the `merge.default` configuration variable can name
941         different merge driver to be used with paths for which the
942         `merge` attribute is unspecified.
944 String::
946         3-way merge is performed using the specified custom
947         merge driver.  The built-in 3-way merge driver can be
948         explicitly specified by asking for "text" driver; the
949         built-in "take the current branch" driver can be
950         requested with "binary".
953 Built-in merge drivers
954 ^^^^^^^^^^^^^^^^^^^^^^
956 There are a few built-in low-level merge drivers defined that
957 can be asked for via the `merge` attribute.
959 text::
961         Usual 3-way file level merge for text files.  Conflicted
962         regions are marked with conflict markers `<<<<<<<`,
963         `=======` and `>>>>>>>`.  The version from your branch
964         appears before the `=======` marker, and the version
965         from the merged branch appears after the `=======`
966         marker.
968 binary::
970         Keep the version from your branch in the work tree, but
971         leave the path in the conflicted state for the user to
972         sort out.
974 union::
976         Run 3-way file level merge for text files, but take
977         lines from both versions, instead of leaving conflict
978         markers.  This tends to leave the added lines in the
979         resulting file in random order and the user should
980         verify the result. Do not use this if you do not
981         understand the implications.
984 Defining a custom merge driver
985 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
987 The definition of a merge driver is done in the `.git/config`
988 file, not in the `gitattributes` file, so strictly speaking this
989 manual page is a wrong place to talk about it.  However...
991 To define a custom merge driver `filfre`, add a section to your
992 `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
994 ----------------------------------------------------------------
995 [merge "filfre"]
996         name = feel-free merge driver
997         driver = filfre %O %A %B %L %P
998         recursive = binary
999 ----------------------------------------------------------------
1001 The `merge.*.name` variable gives the driver a human-readable
1002 name.
1004 The `merge.*.driver` variable's value is used to construct a
1005 command to run to merge ancestor's version (`%O`), current
1006 version (`%A`) and the other branches' version (`%B`).  These
1007 three tokens are replaced with the names of temporary files that
1008 hold the contents of these versions when the command line is
1009 built. Additionally, %L will be replaced with the conflict marker
1010 size (see below).
1012 The merge driver is expected to leave the result of the merge in
1013 the file named with `%A` by overwriting it, and exit with zero
1014 status if it managed to merge them cleanly, or non-zero if there
1015 were conflicts.
1017 The `merge.*.recursive` variable specifies what other merge
1018 driver to use when the merge driver is called for an internal
1019 merge between common ancestors, when there are more than one.
1020 When left unspecified, the driver itself is used for both
1021 internal merge and the final merge.
1023 The merge driver can learn the pathname in which the merged result
1024 will be stored via placeholder `%P`.
1027 `conflict-marker-size`
1028 ^^^^^^^^^^^^^^^^^^^^^^
1030 This attribute controls the length of conflict markers left in
1031 the work tree file during a conflicted merge.  Only setting to
1032 the value to a positive integer has any meaningful effect.
1034 For example, this line in `.gitattributes` can be used to tell the merge
1035 machinery to leave much longer (instead of the usual 7-character-long)
1036 conflict markers when merging the file `Documentation/git-merge.txt`
1037 results in a conflict.
1039 ------------------------
1040 Documentation/git-merge.txt     conflict-marker-size=32
1041 ------------------------
1044 Checking whitespace errors
1045 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1047 `whitespace`
1048 ^^^^^^^^^^^^
1050 The `core.whitespace` configuration variable allows you to define what
1051 'diff' and 'apply' should consider whitespace errors for all paths in
1052 the project (See linkgit:git-config[1]).  This attribute gives you finer
1053 control per path.
1055 Set::
1057         Notice all types of potential whitespace errors known to Git.
1058         The tab width is taken from the value of the `core.whitespace`
1059         configuration variable.
1061 Unset::
1063         Do not notice anything as error.
1065 Unspecified::
1067         Use the value of the `core.whitespace` configuration variable to
1068         decide what to notice as error.
1070 String::
1072         Specify a comma separate list of common whitespace problems to
1073         notice in the same format as the `core.whitespace` configuration
1074         variable.
1077 Creating an archive
1078 ~~~~~~~~~~~~~~~~~~~
1080 `export-ignore`
1081 ^^^^^^^^^^^^^^^
1083 Files and directories with the attribute `export-ignore` won't be added to
1084 archive files.
1086 `export-subst`
1087 ^^^^^^^^^^^^^^
1089 If the attribute `export-subst` is set for a file then Git will expand
1090 several placeholders when adding this file to an archive.  The
1091 expansion depends on the availability of a commit ID, i.e., if
1092 linkgit:git-archive[1] has been given a tree instead of a commit or a
1093 tag then no replacement will be done.  The placeholders are the same
1094 as those for the option `--pretty=format:` of linkgit:git-log[1],
1095 except that they need to be wrapped like this: `$Format:PLACEHOLDERS$`
1096 in the file.  E.g. the string `$Format:%H$` will be replaced by the
1097 commit hash.
1100 Packing objects
1101 ~~~~~~~~~~~~~~~
1103 `delta`
1104 ^^^^^^^
1106 Delta compression will not be attempted for blobs for paths with the
1107 attribute `delta` set to false.
1110 Viewing files in GUI tools
1111 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1113 `encoding`
1114 ^^^^^^^^^^
1116 The value of this attribute specifies the character encoding that should
1117 be used by GUI tools (e.g. linkgit:gitk[1] and linkgit:git-gui[1]) to
1118 display the contents of the relevant file. Note that due to performance
1119 considerations linkgit:gitk[1] does not use this attribute unless you
1120 manually enable per-file encodings in its options.
1122 If this attribute is not set or has an invalid value, the value of the
1123 `gui.encoding` configuration variable is used instead
1124 (See linkgit:git-config[1]).
1128 ----------------------
1130 You do not want any end-of-line conversions applied to, nor textual diffs
1131 produced for, any binary file you track.  You would need to specify e.g.
1133 ------------
1134 *.jpg -text -diff
1135 ------------
1137 but that may become cumbersome, when you have many attributes.  Using
1138 macro attributes, you can define an attribute that, when set, also
1139 sets or unsets a number of other attributes at the same time.  The
1140 system knows a built-in macro attribute, `binary`:
1142 ------------
1143 *.jpg binary
1144 ------------
1146 Setting the "binary" attribute also unsets the "text" and "diff"
1147 attributes as above.  Note that macro attributes can only be "Set",
1148 though setting one might have the effect of setting or unsetting other
1149 attributes or even returning other attributes to the "Unspecified"
1150 state.
1154 -------------------------
1156 Custom macro attributes can be defined only in top-level gitattributes
1157 files (`$GIT_DIR/info/attributes`, the `.gitattributes` file at the
1158 top level of the working tree, or the global or system-wide
1159 gitattributes files), not in `.gitattributes` files in working tree
1160 subdirectories.  The built-in macro attribute "binary" is equivalent
1163 ------------
1164 [attr]binary -diff -merge -text
1165 ------------
1169 -------
1171 If you have these three `gitattributes` file:
1173 ----------------------------------------------------------------
1174 (in $GIT_DIR/info/attributes)
1176 a*      foo !bar -baz
1178 (in .gitattributes)
1179 abc     foo bar baz
1181 (in t/.gitattributes)
1182 ab*     merge=filfre
1183 abc     -foo -bar
1184 *.c     frotz
1185 ----------------------------------------------------------------
1187 the attributes given to path `t/abc` are computed as follows:
1189 1. By examining `t/.gitattributes` (which is in the same
1190    directory as the path in question), Git finds that the first
1191    line matches.  `merge` attribute is set.  It also finds that
1192    the second line matches, and attributes `foo` and `bar`
1193    are unset.
1195 2. Then it examines `.gitattributes` (which is in the parent
1196    directory), and finds that the first line matches, but
1197    `t/.gitattributes` file already decided how `merge`, `foo`
1198    and `bar` attributes should be given to this path, so it
1199    leaves `foo` and `bar` unset.  Attribute `baz` is set.
1201 3. Finally it examines `$GIT_DIR/info/attributes`.  This file
1202    is used to override the in-tree settings.  The first line is
1203    a match, and `foo` is set, `bar` is reverted to unspecified
1204    state, and `baz` is unset.
1206 As the result, the attributes assignment to `t/abc` becomes:
1208 ----------------------------------------------------------------
1209 foo     set to true
1210 bar     unspecified
1211 baz     set to false
1212 merge   set to string value "filfre"
1213 frotz   unspecified
1214 ----------------------------------------------------------------
1218 --------
1219 linkgit:git-check-attr[1].
1223 Part of the linkgit:git[1] suite