| blob | 87882ce8e46efdaf72c2909d0282b03b533278e0 |
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>
525 <h4 id="_interaction_between_checkin_checkout_attributes">Interaction between checkin/checkout attributes</h4>
530 and applicable).</p></div>
535 <div class="para"><p>The attribute <tt>diff</tt> affects how <em>git</em> generates diffs for particular
536 files. It can tell git whether to generate a textual patch for the path
537 or to treat the path as a binary file. It can also affect what line is
539 external command to generate the diff, or ask git to convert binary
540 files to a text format before generating the diff.</p></div>
542 <dt>
543 Set
544 </dt>
545 <dd>
546 <p>
548 as text, even when they contain byte values that
549 normally never appear in text files, such as NUL.
550 </p>
551 </dd>
552 <dt>
553 Unset
554 </dt>
555 <dd>
556 <p>
559 binary patches are enabled).
560 </p>
561 </dd>
562 <dt>
563 Unspecified
564 </dt>
565 <dd>
566 <p>
568 first gets its contents inspected, and if it looks like
569 text, it is treated as text. Otherwise it would
571 </p>
572 </dd>
573 <dt>
574 String
575 </dt>
576 <dd>
577 <p>
578 Diff is shown using the specified diff driver. Each driver may
579 specify one or more options, as described in the following
580 section. The options for the diff driver "foo" are defined
581 by the configuration variables in the "diff.foo" section of the
582 git config file.
583 </p>
584 </dd>
585 </dl></div>
595 command = j-c-diff</tt></pre>
596 </div></div>
604 is prefixed with a line of the form:</p></div>
608 </div></div>
609 <div class="para"><p>This is called a <em>hunk header</em>. The "TEXT" portion is by default a line
610 that begins with an alphabet, an underscore or a dollar sign; this
612 is not suited for some contents, and you can use a customized pattern
613 to make a selection.</p></div>
615 for paths.</p></div>
619 </div></div>
621 specify a regular expression that matches a line that you would
622 want to appear as the hunk header "TEXT". Add a section to your
628 </div></div>
630 configuration file parser, so you would need to double the
631 backslashes; the pattern above picks a line that begins with a
635 is one of them, so you do not have to write the above in your
636 configuration file (you still need to enable this with the
638 patterns are available:</p></div>
640 <li>
641 <p>
643 </p>
644 </li>
645 <li>
646 <p>
648 </p>
649 </li>
650 <li>
651 <p>
653 </p>
654 </li>
655 <li>
656 <p>
658 </p>
659 </li>
660 <li>
661 <p>
663 </p>
664 </li>
665 <li>
666 <p>
668 </p>
669 </li>
670 <li>
671 <p>
673 </p>
674 </li>
675 <li>
676 <p>
678 </p>
679 </li>
680 <li>
681 <p>
683 </p>
684 </li>
685 <li>
686 <p>
688 </p>
689 </li>
690 </ul></div>
693 split words in a line, by specifying an appropriate regular expression
694 in the "diff.*.wordRegex" configuration variable. For example, in TeX
695 a backslash followed by a sequence of letters forms a command, but
696 several such commands can be run together without intervening
697 whitespace. To separate them, use a regular expression in your
703 </div></div>
705 previous section.</p></div>
708 version of some binary files. For example, a word processor
709 document can be converted to an ASCII text representation, and
710 the diff of the text shown. Even though this conversion loses
711 some information, the resulting diff is useful for human
712 viewing (but cannot be applied directly).</p></div>
714 performing such a conversion. The program should take a single
715 argument, the name of a file to convert, and produce the
716 resulting text on stdout.</p></div>
718 file instead of the binary information (assuming you have the
719 exif tool installed), add the following section to your
724 textconv = exif</tt></pre>
725 </div></div>
727 <table><tr>
730 </td>
732 in this example, we lose the actual image contents and focus
733 just on the text data. This means that diffs generated by
734 textconv are _not_ suitable for applying. For this reason,
736 log, whatchanged, show) will perform text conversion. <tt>git
737 format-patch</tt> will never generate this output. If you want to
738 send somebody a text-converted diff of a binary file (e.g.,
739 because it quickly conveys the changes you have made), you
740 should generate it separately and send it as a comment _in
741 addition to_ the usual binary diff that you might send.</td>
742 </tr></table>
743 </div>
744 <h3 id="_performing_a_three_way_merge">Performing a three-way merge</h3><div style="clear:left"></div>
750 <dt>
751 Set
752 </dt>
753 <dd>
754 <p>
755 Built-in 3-way merge driver is used to merge the
757 suite. This is suitable for ordinary text files.
758 </p>
759 </dd>
760 <dt>
761 Unset
762 </dt>
763 <dd>
764 <p>
765 Take the version from the current branch as the
766 tentative merge result, and declare that the merge has
767 conflicts. This is suitable for binary files that does
768 not have a well-defined merge semantics.
769 </p>
770 </dd>
771 <dt>
772 Unspecified
773 </dt>
774 <dd>
775 <p>
776 By default, this uses the same built-in 3-way merge
779 different merge driver to be used for paths to which the
781 </p>
782 </dd>
783 <dt>
784 String
785 </dt>
786 <dd>
787 <p>
788 3-way merge is performed using the specified custom
789 merge driver. The built-in 3-way merge driver can be
790 explicitly specified by asking for "text" driver; the
791 built-in "take the current branch" driver can be
792 requested with "binary".
793 </p>
794 </dd>
795 </dl></div>
800 <dt>
801 text
802 </dt>
803 <dd>
804 <p>
805 Usual 3-way file level merge for text files. Conflicted
810 marker.
811 </p>
812 </dd>
813 <dt>
814 binary
815 </dt>
816 <dd>
817 <p>
818 Keep the version from your branch in the work tree, but
819 leave the path in the conflicted state for the user to
820 sort out.
821 </p>
822 </dd>
823 <dt>
824 union
825 </dt>
826 <dd>
827 <p>
828 Run 3-way file level merge for text files, but take
829 lines from both versions, instead of leaving conflict
830 markers. This tends to leave the added lines in the
831 resulting file in random order and the user should
832 verify the result. Do not use this if you do not
833 understand the implications.
834 </p>
835 </dd>
836 </dl></div>
846 name = feel-free merge driver
847 driver = filfre %O %A %B
848 recursive = binary</tt></pre>
849 </div></div>
851 name.</p></div>
855 three tokens are replaced with the names of temporary files that
856 hold the contents of these versions when the command line is
857 built.</p></div>
860 status if it managed to merge them cleanly, or non-zero if there
861 were conflicts.</p></div>
863 driver to use when the merge driver is called for an internal
864 merge between common ancestors, when there are more than one.
865 When left unspecified, the driver itself is used for both
866 internal merge and the final merge.</p></div>
867 <h3 id="_checking_whitespace_errors">Checking whitespace errors</h3><div style="clear:left"></div>
869 <div class="para"><p>The <tt>core.whitespace</tt> configuration variable allows you to define what
872 control per path.</p></div>
874 <dt>
875 Set
876 </dt>
877 <dd>
878 <p>
879 Notice all types of potential whitespace errors known to git.
880 </p>
881 </dd>
882 <dt>
883 Unset
884 </dt>
885 <dd>
886 <p>
887 Do not notice anything as error.
888 </p>
889 </dd>
890 <dt>
891 Unspecified
892 </dt>
893 <dd>
894 <p>
896 decide what to notice as error.
897 </p>
898 </dd>
899 <dt>
900 String
901 </dt>
902 <dd>
903 <p>
904 Specify a comma separate list of common whitespace problems to
906 variable.
907 </p>
908 </dd>
909 </dl></div>
912 <div class="para"><p>Files and directories with the attribute <tt>export-ignore</tt> won't be added to
913 archive files.</p></div>
915 <div class="para"><p>If the attribute <tt>export-subst</tt> is set for a file then git will expand
916 several placeholders when adding this file to an archive. The
917 expansion depends on the availability of a commit ID, i.e., if
919 tag then no replacement will be done. The placeholders are the same
923 commit hash.</p></div>
924 <h3 id="_viewing_files_in_gui_tools">Viewing files in GUI tools</h3><div style="clear:left"></div>
927 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
928 display the contents of the relevant file. Note that due to performance
930 manually enable per-file encodings in its options.</p></div>
934 </div>
938 produced for, any binary file you track. You would need to specify e.g.</p></div>
942 </div></div>
944 attribute macros, you can specify groups of attributes set or unset at
949 </div></div>
953 </div>
956 <div class="para"><p>Custom attribute macros can be defined only in the <tt>.gitattributes</tt> file
957 at the toplevel (i.e. not in any subdirectory). The built-in attribute
962 </div></div>
963 </div>
969 <pre><tt>(in $GIT_DIR/info/attributes)
971 a* foo !bar -baz
973 (in .gitattributes)
974 abc foo bar baz
976 (in t/.gitattributes)
977 ab* merge=filfre
978 abc -foo -bar
979 *.c frotz</tt></pre>
980 </div></div>
981 <div class="para"><p>the attributes given to path <tt>t/abc</tt> are computed as follows:</p></div>
983 <li>
984 <p>
986 directory as the path in question), git finds that the first
989 are unset.
990 </p>
991 </li>
992 <li>
993 <p>
995 directory), and finds that the first line matches, but
999 </p>
1000 </li>
1001 <li>
1002 <p>
1004 is used to override the in-tree settings. The first line is
1007 </p>
1008 </li>
1009 </ol></div>
1010 <div class="para"><p>As the result, the attributes assignment to <tt>t/abc</tt> becomes:</p></div>
1013 <pre><tt>foo set to true
1014 bar unspecified
1015 baz set to false
1016 merge set to string value "filfre"
1017 frotz unspecified</tt></pre>
1018 </div></div>
1019 </div>
1023 </div>
1027 </div>
1028 </div>
1029 </body>
1030 </html>