| blob | ed1ff5278f6f58253942e5390927a8324786220d |
4 <head>
8 /* Debug borders */
10 /*
11 border: 1px solid red;
12 */
13 }
15 body {
17 }
19 a {
22 }
25 }
27 em {
29 }
31 strong {
33 }
35 tt {
37 }
45 }
49 }
50 h2 {
52 }
53 h3 {
55 }
56 h3 + * {
58 }
63 }
65 hr {
67 }
69 p {
72 }
74 pre {
77 }
79 span#author {
84 }
85 span#email {
86 }
87 span#revision {
89 }
91 div#footer {
97 }
98 div#footer-text {
101 }
102 div#footer-badges {
105 }
107 div#preamble,
114 }
118 }
122 }
124 /* Block element titles. */
131 }
134 }
138 }
141 }
144 }
150 }
154 }
159 }
163 }
167 }
170 }
179 }
183 }
188 }
192 }
198 dl {
201 }
202 dt {
206 }
209 }
213 }
216 }
220 }
221 thead {
224 }
225 tfoot {
227 }
232 }
235 }
240 }
243 }
247 }
249 div#toctitle {
256 }
261 }
265 }
269 }
273 }
275 /* Workarounds for IE6's broken and incomplete CSS2. */
281 }
287 }
293 }
297 }
302 }
304 /* IE6 sets dynamically generated links as visited. */
306 </style>
308 </head>
309 <body>
311 <h1>
312 gitattributes(5) Manual Page
313 </h1>
316 <p>gitattributes -
317 defining attributes per path
318 </p>
319 </div>
320 </div>
324 </div>
333 </div></div>
335 separated by whitespaces. When the pattern matches the
336 path in question, the attributes listed on the line are given to
337 the path.</p></div>
340 <dt>
341 Set
342 </dt>
343 <dd>
344 <p>
345 The path has the attribute with special value "true";
346 this is specified by listing only the name of the
347 attribute in the attribute list.
348 </p>
349 </dd>
350 <dt>
351 Unset
352 </dt>
353 <dd>
354 <p>
355 The path has the attribute with special value "false";
356 this is specified by listing the name of the attribute
358 </p>
359 </dd>
360 <dt>
361 Set to a value
362 </dt>
363 <dd>
364 <p>
365 The path has the attribute with specified string value;
366 this is specified by listing the name of the attribute
368 attribute list.
369 </p>
370 </dd>
371 <dt>
372 Unspecified
373 </dt>
374 <dd>
375 <p>
376 No pattern matches the path, and nothing says if
377 the path has or does not have the attribute, the
378 attribute for the path is said to be Unspecified.
379 </p>
380 </dd>
381 </dl></div>
383 overrides an earlier line. This overriding is done per
384 attribute. The rules how the pattern matches paths are the
389 path in question, and its parent directories up to the toplevel of the
391 is from the path in question, the lower its precedence).</p></div>
393 attributes to files that are particular to one user's workflow), then
395 Attributes which should be version-controlled and distributed to other
396 repositories (i.e., attributes of interest to all users) should go into
401 </div>
405 particular attributes to a path. Currently, the following
406 operations are attributes-aware.</p></div>
407 <h3 id="_checking_out_and_checking_in">Checking-out and checking-in</h3><div style="clear:left"></div>
409 repository are copied to the working tree files when commands
411 git stores the contents you prepare in the working tree in the
416 <dt>
417 Set
418 </dt>
419 <dd>
420 <p>
423 takes place without guessing the content type by
424 inspection.
425 </p>
426 </dd>
427 <dt>
428 Unset
429 </dt>
430 <dd>
431 <p>
433 attempt any end-of-line conversion upon checkin or checkout.
434 </p>
435 </dd>
436 <dt>
437 Unspecified
438 </dt>
439 <dd>
440 <p>
443 like text.
444 </p>
445 </dd>
446 <dt>
447 Set to string value "input"
448 </dt>
449 <dd>
450 <p>
454 </p>
455 </dd>
456 </dl></div>
458 as if the attribute is left unspecified.</p></div>
461 conversion is done.</p></div>
463 CRLF line endings for files in the working tree, and you want to
464 convert them back to the normal LF line endings when checking
465 in to the repository.</p></div>
467 converted to LF upon checkin, but there is no conversion done
468 upon checkout.</p></div>
470 the conversion is reversible for the current setting of
472 conversions; for "warn", git only prints a warning but accepts
473 an irreversible conversion. The safety triggers to prevent such
474 a conversion done to the files in the work tree, but there are a
477 <li>
478 <p>
480 next checkout would, so the safety triggers;
481 </p>
482 </li>
483 <li>
484 <p>
486 in the work tree, but the operation is about text files and CRLF
487 conversion is about fixing the line ending inconsistencies, so the
488 safety does not trigger;
489 </p>
490 </li>
491 <li>
492 <p>
495 catch potential problems early, safety triggers.
496 </p>
497 </li>
498 </ul></div>
502 40-character hexadecimal blob object name, followed by a dollar
508 filter driver specified in the configuration.</p></div>
510 command, either of which can be left unspecified. Upon
512 fed the blob object from its standard input, and its standard
513 output is used to update the worktree file. Similarly, the
515 upon checkin.</p></div>
517 but makes the filter a no-op passthru.</p></div>
519 shape that is more convenient for the platform, filesystem, and
520 the user to use. The key phrase here is "more convenient" and not
521 "turning something unusable into usable". In other words, the
522 intent is that if someone unsets the filter driver definition,
523 or does not have the appropriate filter program, the project
524 should still be usable.</p></div>
526 attribute for paths.</p></div>
530 </div></div>
532 configuration in your .git/config to specify a pair of commands to
533 modify the contents of C programs when the source files are checked
534 in ("clean" is run) and checked out (no change is made because the
539 clean = indent
540 smudge = cat</tt></pre>
541 </div></div>
542 <h4 id="_interaction_between_checkin_checkout_attributes">Interaction between checkin/checkout attributes</h4>
547 and applicable).</p></div>
552 <div class="para"><p>The attribute <tt>diff</tt> affects how <em>git</em> generates diffs for particular
553 files. It can tell git whether to generate a textual patch for the path
554 or to treat the path as a binary file. It can also affect what line is
556 external command to generate the diff, or ask git to convert binary
557 files to a text format before generating the diff.</p></div>
559 <dt>
560 Set
561 </dt>
562 <dd>
563 <p>
565 as text, even when they contain byte values that
566 normally never appear in text files, such as NUL.
567 </p>
568 </dd>
569 <dt>
570 Unset
571 </dt>
572 <dd>
573 <p>
576 binary patches are enabled).
577 </p>
578 </dd>
579 <dt>
580 Unspecified
581 </dt>
582 <dd>
583 <p>
585 first gets its contents inspected, and if it looks like
586 text, it is treated as text. Otherwise it would
588 </p>
589 </dd>
590 <dt>
591 String
592 </dt>
593 <dd>
594 <p>
595 Diff is shown using the specified diff driver. Each driver may
596 specify one or more options, as described in the following
597 section. The options for the diff driver "foo" are defined
598 by the configuration variables in the "diff.foo" section of the
599 git config file.
600 </p>
601 </dd>
602 </dl></div>
612 command = j-c-diff</tt></pre>
613 </div></div>
621 is prefixed with a line of the form:</p></div>
625 </div></div>
626 <div class="para"><p>This is called a <em>hunk header</em>. The "TEXT" portion is by default a line
627 that begins with an alphabet, an underscore or a dollar sign; this
629 is not suited for some contents, and you can use a customized pattern
630 to make a selection.</p></div>
632 for paths.</p></div>
636 </div></div>
638 specify a regular expression that matches a line that you would
639 want to appear as the hunk header "TEXT". Add a section to your
645 </div></div>
647 configuration file parser, so you would need to double the
648 backslashes; the pattern above picks a line that begins with a
652 is one of them, so you do not have to write the above in your
653 configuration file (you still need to enable this with the
655 patterns are available:</p></div>
657 <li>
658 <p>
660 </p>
661 </li>
662 <li>
663 <p>
665 </p>
666 </li>
667 <li>
668 <p>
670 </p>
671 </li>
672 <li>
673 <p>
675 </p>
676 </li>
677 <li>
678 <p>
680 </p>
681 </li>
682 <li>
683 <p>
685 </p>
686 </li>
687 <li>
688 <p>
690 </p>
691 </li>
692 <li>
693 <p>
695 </p>
696 </li>
697 <li>
698 <p>
700 </p>
701 </li>
702 <li>
703 <p>
705 </p>
706 </li>
707 </ul></div>
710 split words in a line, by specifying an appropriate regular expression
711 in the "diff.*.wordRegex" configuration variable. For example, in TeX
712 a backslash followed by a sequence of letters forms a command, but
713 several such commands can be run together without intervening
714 whitespace. To separate them, use a regular expression in your
720 </div></div>
722 previous section.</p></div>
725 version of some binary files. For example, a word processor
726 document can be converted to an ASCII text representation, and
727 the diff of the text shown. Even though this conversion loses
728 some information, the resulting diff is useful for human
729 viewing (but cannot be applied directly).</p></div>
731 performing such a conversion. The program should take a single
732 argument, the name of a file to convert, and produce the
733 resulting text on stdout.</p></div>
735 file instead of the binary information (assuming you have the
736 exif tool installed), add the following section to your
741 textconv = exif</tt></pre>
742 </div></div>
744 <table><tr>
747 </td>
749 in this example, we lose the actual image contents and focus
750 just on the text data. This means that diffs generated by
751 textconv are _not_ suitable for applying. For this reason,
753 log, whatchanged, show) will perform text conversion. <tt>git
754 format-patch</tt> will never generate this output. If you want to
755 send somebody a text-converted diff of a binary file (e.g.,
756 because it quickly conveys the changes you have made), you
757 should generate it separately and send it as a comment _in
758 addition to_ the usual binary diff that you might send.</td>
759 </tr></table>
760 </div>
763 to cache the output and use it in future diffs. To enable
764 caching, set the "cachetextconv" variable in your diff driver's
765 config. For example:</p></div>
769 textconv = exif
770 cachetextconv = true</tt></pre>
771 </div></div>
773 indefinitely. If you change the textconv config variable for a
774 diff driver, git will automatically invalidate the cache entries
775 and re-run the textconv filter. If you want to invalidate the
776 cache manually (e.g., because your version of "exif" was updated
777 and now produces better output), you can remove the cache
780 <h3 id="_performing_a_three_way_merge">Performing a three-way merge</h3><div style="clear:left"></div>
786 <dt>
787 Set
788 </dt>
789 <dd>
790 <p>
791 Built-in 3-way merge driver is used to merge the
793 suite. This is suitable for ordinary text files.
794 </p>
795 </dd>
796 <dt>
797 Unset
798 </dt>
799 <dd>
800 <p>
801 Take the version from the current branch as the
802 tentative merge result, and declare that the merge has
803 conflicts. This is suitable for binary files that does
804 not have a well-defined merge semantics.
805 </p>
806 </dd>
807 <dt>
808 Unspecified
809 </dt>
810 <dd>
811 <p>
812 By default, this uses the same built-in 3-way merge
815 different merge driver to be used for paths to which the
817 </p>
818 </dd>
819 <dt>
820 String
821 </dt>
822 <dd>
823 <p>
824 3-way merge is performed using the specified custom
825 merge driver. The built-in 3-way merge driver can be
826 explicitly specified by asking for "text" driver; the
827 built-in "take the current branch" driver can be
828 requested with "binary".
829 </p>
830 </dd>
831 </dl></div>
836 <dt>
837 text
838 </dt>
839 <dd>
840 <p>
841 Usual 3-way file level merge for text files. Conflicted
846 marker.
847 </p>
848 </dd>
849 <dt>
850 binary
851 </dt>
852 <dd>
853 <p>
854 Keep the version from your branch in the work tree, but
855 leave the path in the conflicted state for the user to
856 sort out.
857 </p>
858 </dd>
859 <dt>
860 union
861 </dt>
862 <dd>
863 <p>
864 Run 3-way file level merge for text files, but take
865 lines from both versions, instead of leaving conflict
866 markers. This tends to leave the added lines in the
867 resulting file in random order and the user should
868 verify the result. Do not use this if you do not
869 understand the implications.
870 </p>
871 </dd>
872 </dl></div>
882 name = feel-free merge driver
883 driver = filfre %O %A %B
884 recursive = binary</tt></pre>
885 </div></div>
887 name.</p></div>
891 three tokens are replaced with the names of temporary files that
892 hold the contents of these versions when the command line is
893 built. Additionally, %L will be replaced with the conflict marker
894 size (see below).</p></div>
897 status if it managed to merge them cleanly, or non-zero if there
898 were conflicts.</p></div>
900 driver to use when the merge driver is called for an internal
901 merge between common ancestors, when there are more than one.
902 When left unspecified, the driver itself is used for both
903 internal merge and the final merge.</p></div>
906 the work tree file during a conflicted merge. Only setting to
907 the value to a positive integer has any meaningful effect.</p></div>
908 <div class="para"><p>For example, this line in <tt>.gitattributes</tt> can be used to tell the merge
909 machinery to leave much longer (instead of the usual 7-character-long)
911 results in a conflict.</p></div>
915 </div></div>
916 <h3 id="_checking_whitespace_errors">Checking whitespace errors</h3><div style="clear:left"></div>
918 <div class="para"><p>The <tt>core.whitespace</tt> configuration variable allows you to define what
921 control per path.</p></div>
923 <dt>
924 Set
925 </dt>
926 <dd>
927 <p>
928 Notice all types of potential whitespace errors known to git.
929 </p>
930 </dd>
931 <dt>
932 Unset
933 </dt>
934 <dd>
935 <p>
936 Do not notice anything as error.
937 </p>
938 </dd>
939 <dt>
940 Unspecified
941 </dt>
942 <dd>
943 <p>
945 decide what to notice as error.
946 </p>
947 </dd>
948 <dt>
949 String
950 </dt>
951 <dd>
952 <p>
953 Specify a comma separate list of common whitespace problems to
955 variable.
956 </p>
957 </dd>
958 </dl></div>
961 <div class="para"><p>Files and directories with the attribute <tt>export-ignore</tt> won't be added to
962 archive files.</p></div>
964 <div class="para"><p>If the attribute <tt>export-subst</tt> is set for a file then git will expand
965 several placeholders when adding this file to an archive. The
966 expansion depends on the availability of a commit ID, i.e., if
968 tag then no replacement will be done. The placeholders are the same
972 commit hash.</p></div>
977 <h3 id="_viewing_files_in_gui_tools">Viewing files in GUI tools</h3><div style="clear:left"></div>
980 be used by GUI tools (e.g. <a href="gitk.html">gitk(1)</a> and <a href="git-gui.html">git-gui(1)</a>) to
981 display the contents of the relevant file. Note that due to performance
983 manually enable per-file encodings in its options.</p></div>
987 </div>
991 produced for, any binary file you track. You would need to specify e.g.</p></div>
995 </div></div>
997 attribute macros, you can specify groups of attributes set or unset at
1002 </div></div>
1006 </div>
1009 <div class="para"><p>Custom attribute macros can be defined only in the <tt>.gitattributes</tt> file
1010 at the toplevel (i.e. not in any subdirectory). The built-in attribute
1015 </div></div>
1016 </div>
1022 <pre><tt>(in $GIT_DIR/info/attributes)
1024 a* foo !bar -baz
1026 (in .gitattributes)
1027 abc foo bar baz
1029 (in t/.gitattributes)
1030 ab* merge=filfre
1031 abc -foo -bar
1032 *.c frotz</tt></pre>
1033 </div></div>
1034 <div class="para"><p>the attributes given to path <tt>t/abc</tt> are computed as follows:</p></div>
1036 <li>
1037 <p>
1039 directory as the path in question), git finds that the first
1042 are unset.
1043 </p>
1044 </li>
1045 <li>
1046 <p>
1048 directory), and finds that the first line matches, but
1052 </p>
1053 </li>
1054 <li>
1055 <p>
1057 is used to override the in-tree settings. The first line is
1060 </p>
1061 </li>
1062 </ol></div>
1063 <div class="para"><p>As the result, the attributes assignment to <tt>t/abc</tt> becomes:</p></div>
1066 <pre><tt>foo set to true
1067 bar unspecified
1068 baz set to false
1069 merge set to string value "filfre"
1070 frotz unspecified</tt></pre>
1071 </div></div>
1072 </div>
1076 </div>
1080 </div>
1081 </div>
1082 </body>
1083 </html>