f44a2fc2fdb3c82b2ec4a9968657fdcb4918db1e
[git.git] / git-diff-tree.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
4 <head>\r
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
6 <meta name="generator" content="AsciiDoc 7.0.1" />\r
7 <style type="text/css">\r
8 /* Debug borders */\r
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
10 /*\r
11   border: 1px solid red;\r
12 */\r
13 }\r
14 \r
15 body {\r
16   margin: 1em 5% 1em 5%;\r
17 }\r
18 \r
19 a { color: blue; }\r
20 a:visited { color: fuchsia; }\r
21 \r
22 em {\r
23   font-style: italic;\r
24 }\r
25 \r
26 strong {\r
27   font-weight: bold;\r
28 }\r
29 \r
30 tt {\r
31   color: navy;\r
32 }\r
33 \r
34 h1, h2, h3, h4, h5, h6 {\r
35   color: #527bbd;\r
36   font-family: sans-serif;\r
37   margin-top: 1.2em;\r
38   margin-bottom: 0.5em;\r
39   line-height: 1.3;\r
40 }\r
41 \r
42 h1 {\r
43   border-bottom: 2px solid silver;\r
44 }\r
45 h2 {\r
46   border-bottom: 2px solid silver;\r
47   padding-top: 0.5em;\r
48 }\r
49 \r
50 div.sectionbody {\r
51   font-family: serif;\r
52   margin-left: 0;\r
53 }\r
54 \r
55 hr {\r
56   border: 1px solid silver;\r
57 }\r
58 \r
59 p {\r
60   margin-top: 0.5em;\r
61   margin-bottom: 0.5em;\r
62 }\r
63 \r
64 pre {\r
65   padding: 0;\r
66   margin: 0;\r
67 }\r
68 \r
69 span#author {\r
70   color: #527bbd;\r
71   font-family: sans-serif;\r
72   font-weight: bold;\r
73   font-size: 1.2em;\r
74 }\r
75 span#email {\r
76 }\r
77 span#revision {\r
78   font-family: sans-serif;\r
79 }\r
80 \r
81 div#footer {\r
82   font-family: sans-serif;\r
83   font-size: small;\r
84   border-top: 2px solid silver;\r
85   padding-top: 0.5em;\r
86   margin-top: 4.0em;\r
87 }\r
88 div#footer-text {\r
89   float: left;\r
90   padding-bottom: 0.5em;\r
91 }\r
92 div#footer-badges {\r
93   float: right;\r
94   padding-bottom: 0.5em;\r
95 }\r
96 \r
97 div#preamble,\r
98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
100 div.admonitionblock {\r
101   margin-right: 10%;\r
102   margin-top: 1.5em;\r
103   margin-bottom: 1.5em;\r
104 }\r
105 div.admonitionblock {\r
106   margin-top: 2.5em;\r
107   margin-bottom: 2.5em;\r
108 }\r
109 \r
110 div.content { /* Block element content. */\r
111   padding: 0;\r
112 }\r
113 \r
114 /* Block element titles. */\r
115 div.title, caption.title {\r
116   font-family: sans-serif;\r
117   font-weight: bold;\r
118   text-align: left;\r
119   margin-top: 1.0em;\r
120   margin-bottom: 0.5em;\r
121 }\r
122 div.title + * {\r
123   margin-top: 0;\r
124 }\r
125 \r
126 td div.title:first-child {\r
127   margin-top: 0.0em;\r
128 }\r
129 div.content div.title:first-child {\r
130   margin-top: 0.0em;\r
131 }\r
132 div.content + div.title {\r
133   margin-top: 0.0em;\r
134 }\r
135 \r
136 div.sidebarblock > div.content {\r
137   background: #ffffee;\r
138   border: 1px solid silver;\r
139   padding: 0.5em;\r
140 }\r
141 \r
142 div.listingblock > div.content {\r
143   border: 1px solid silver;\r
144   background: #f4f4f4;\r
145   padding: 0.5em;\r
146 }\r
147 \r
148 div.quoteblock > div.content {\r
149   padding-left: 2.0em;\r
150 }\r
151 div.quoteblock .attribution {\r
152   text-align: right;\r
153 }\r
154 \r
155 div.admonitionblock .icon {\r
156   vertical-align: top;\r
157   font-size: 1.1em;\r
158   font-weight: bold;\r
159   text-decoration: underline;\r
160   color: #527bbd;\r
161   padding-right: 0.5em;\r
162 }\r
163 div.admonitionblock td.content {\r
164   padding-left: 0.5em;\r
165   border-left: 2px solid silver;\r
166 }\r
167 \r
168 div.exampleblock > div.content {\r
169   border-left: 2px solid silver;\r
170   padding: 0.5em;\r
171 }\r
172 \r
173 div.verseblock div.content {\r
174   white-space: pre;\r
175 }\r
176 \r
177 div.imageblock div.content { padding-left: 0; }\r
178 div.imageblock img { border: 1px solid silver; }\r
179 span.image img { border-style: none; }\r
180 \r
181 dl {\r
182   margin-top: 0.8em;\r
183   margin-bottom: 0.8em;\r
184 }\r
185 dt {\r
186   margin-top: 0.5em;\r
187   margin-bottom: 0;\r
188   font-style: italic;\r
189 }\r
190 dd > *:first-child {\r
191   margin-top: 0;\r
192 }\r
193 \r
194 ul, ol {\r
195     list-style-position: outside;\r
196 }\r
197 ol.olist2 {\r
198   list-style-type: lower-alpha;\r
199 }\r
200 \r
201 div.tableblock > table {\r
202   border-color: #527bbd;\r
203   border-width: 3px;\r
204 }\r
205 thead {\r
206   font-family: sans-serif;\r
207   font-weight: bold;\r
208 }\r
209 tfoot {\r
210   font-weight: bold;\r
211 }\r
212 \r
213 div.hlist {\r
214   margin-top: 0.8em;\r
215   margin-bottom: 0.8em;\r
216 }\r
217 td.hlist1 {\r
218   vertical-align: top;\r
219   font-style: italic;\r
220   padding-right: 0.8em;\r
221 }\r
222 td.hlist2 {\r
223   vertical-align: top;\r
224 }\r
225 \r
226 @media print {\r
227   div#footer-badges { display: none; }\r
228 }\r
229 include::./stylesheets/xhtml11-manpage.css[]\r
230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
231 \r
232 div.sidebar-content {\r
233   background: #ffffee;\r
234   border: 1px solid silver;\r
235   padding: 0.5em;\r
236 }\r
237 div.sidebar-title, div.image-title {\r
238   font-family: sans-serif;\r
239   font-weight: bold;\r
240   margin-top: 0.0em;\r
241   margin-bottom: 0.5em;\r
242 }\r
243 \r
244 div.listingblock div.content {\r
245   border: 1px solid silver;\r
246   background: #f4f4f4;\r
247   padding: 0.5em;\r
248 }\r
249 \r
250 div.quoteblock-content {\r
251   padding-left: 2.0em;\r
252 }\r
253 \r
254 div.exampleblock-content {\r
255   border-left: 2px solid silver;\r
256   padding-left: 0.5em;\r
257 }\r
258 </style>\r
259 <title>git-diff-tree(1)</title>\r
260 </head>\r
261 <body>\r
262 <div id="header">\r
263 <h1>\r
264 git-diff-tree(1) Manual Page\r
265 </h1>\r
266 <h2>NAME</h2>\r
267 <div class="sectionbody">\r
268 <p>git-diff-tree -\r
269    Compares the content and mode of blobs found via two tree objects\r
270 </p>\r
271 </div>\r
272 </div>\r
273 <h2>SYNOPSIS</h2>\r
274 <div class="sectionbody">\r
275 <div class="verseblock">\r
276 <div class="content"><em>git-diff-tree</em> [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty]\r
277               [-t] [-r] [-c | --cc] [--root] [&lt;common diff options&gt;]\r
278               &lt;tree-ish&gt; [&lt;tree-ish&gt;] [&lt;path&gt;&#8230;]</div></div>\r
279 </div>\r
280 <h2>DESCRIPTION</h2>\r
281 <div class="sectionbody">\r
282 <p>Compares the content and mode of the blobs found via two tree objects.</p>\r
283 <p>If there is only one &lt;tree-ish&gt; given, the commit is compared with its parents\r
284 (see --stdin below).</p>\r
285 <p>Note that "git-diff-tree" can use the tree encapsulated in a commit object.</p>\r
286 </div>\r
287 <h2>OPTIONS</h2>\r
288 <div class="sectionbody">\r
289 <dl>\r
290 <dt>\r
291 -p\r
292 </dt>\r
293 <dd>\r
294 <p>\r
295         Generate patch (see section on generating patches)\r
296 </p>\r
297 </dd>\r
298 <dt>\r
299 -u\r
300 </dt>\r
301 <dd>\r
302 <p>\r
303         Synonym for "-p".\r
304 </p>\r
305 </dd>\r
306 <dt>\r
307 -z\r
308 </dt>\r
309 <dd>\r
310 <p>\r
311         \0 line termination on output\r
312 </p>\r
313 </dd>\r
314 <dt>\r
315 --name-only\r
316 </dt>\r
317 <dd>\r
318 <p>\r
319         Show only names of changed files.\r
320 </p>\r
321 </dd>\r
322 <dt>\r
323 --name-status\r
324 </dt>\r
325 <dd>\r
326 <p>\r
327         Show only names and status of changed files.\r
328 </p>\r
329 </dd>\r
330 <dt>\r
331 --full-index\r
332 </dt>\r
333 <dd>\r
334 <p>\r
335         Instead of the first handful characters, show full\r
336         object name of pre- and post-image blob on the "index"\r
337         line when generating a patch format output.\r
338 </p>\r
339 </dd>\r
340 <dt>\r
341 --abbrev[=&lt;n&gt;]\r
342 </dt>\r
343 <dd>\r
344 <p>\r
345         Instead of showing the full 40-byte hexadecimal object\r
346         name in diff-raw format output and diff-tree header\r
347         lines, show only handful hexdigits prefix.  This is\r
348         independent of --full-index option above, which controls\r
349         the diff-patch output format.  Non default number of\r
350         digits can be specified with --abbrev=&lt;n&gt;.\r
351 </p>\r
352 </dd>\r
353 <dt>\r
354 -B\r
355 </dt>\r
356 <dd>\r
357 <p>\r
358         Break complete rewrite changes into pairs of delete and create.\r
359 </p>\r
360 </dd>\r
361 <dt>\r
362 -M\r
363 </dt>\r
364 <dd>\r
365 <p>\r
366         Detect renames.\r
367 </p>\r
368 </dd>\r
369 <dt>\r
370 -C\r
371 </dt>\r
372 <dd>\r
373 <p>\r
374         Detect copies as well as renames.\r
375 </p>\r
376 </dd>\r
377 <dt>\r
378 --find-copies-harder\r
379 </dt>\r
380 <dd>\r
381 <p>\r
382         For performance reasons, by default, -C option finds copies only\r
383         if the original file of the copy was modified in the same\r
384         changeset.  This flag makes the command\r
385         inspect unmodified files as candidates for the source of\r
386         copy.  This is a very expensive operation for large\r
387         projects, so use it with caution.\r
388 </p>\r
389 </dd>\r
390 <dt>\r
391 -l&lt;num&gt;\r
392 </dt>\r
393 <dd>\r
394 <p>\r
395         -M and -C options require O(n^2) processing time where n\r
396         is the number of potential rename/copy targets.  This\r
397         option prevents rename/copy detection from running if\r
398         the number of rename/copy targets exceeds the specified\r
399         number.\r
400 </p>\r
401 </dd>\r
402 <dt>\r
403 -S&lt;string&gt;\r
404 </dt>\r
405 <dd>\r
406 <p>\r
407         Look for differences that contain the change in &lt;string&gt;.\r
408 </p>\r
409 </dd>\r
410 <dt>\r
411 --pickaxe-all\r
412 </dt>\r
413 <dd>\r
414 <p>\r
415         When -S finds a change, show all the changes in that\r
416         changeset, not just the files that contain the change\r
417         in &lt;string&gt;.\r
418 </p>\r
419 </dd>\r
420 <dt>\r
421 -O&lt;orderfile&gt;\r
422 </dt>\r
423 <dd>\r
424 <p>\r
425         Output the patch in the order specified in the\r
426         &lt;orderfile&gt;, which has one shell glob pattern per line.\r
427 </p>\r
428 </dd>\r
429 <dt>\r
430 -R\r
431 </dt>\r
432 <dd>\r
433 <p>\r
434         Swap two inputs; that is, show differences from index or\r
435         on-disk file to tree contents.\r
436 </p>\r
437 </dd>\r
438 </dl>\r
439 <p>For more detailed explanation on these common options, see also\r
440 <a href="diffcore.html">diffcore documentation</a>.</p>\r
441 <dl>\r
442 <dt>\r
443 &lt;tree-ish&gt;\r
444 </dt>\r
445 <dd>\r
446 <p>\r
447         The id of a tree object.\r
448 </p>\r
449 </dd>\r
450 <dt>\r
451 &lt;path&gt;&#8230;\r
452 </dt>\r
453 <dd>\r
454 <p>\r
455         If provided, the results are limited to a subset of files\r
456         matching one of these prefix strings.\r
457         ie file matches <tt>/^&lt;pattern1&gt;|&lt;pattern2&gt;|&#8230;/</tt>\r
458         Note that this parameter does not provide any wildcard or regexp\r
459         features.\r
460 </p>\r
461 </dd>\r
462 <dt>\r
463 -r\r
464 </dt>\r
465 <dd>\r
466 <p>\r
467         recurse into sub-trees\r
468 </p>\r
469 </dd>\r
470 <dt>\r
471 -t\r
472 </dt>\r
473 <dd>\r
474 <p>\r
475         show tree entry itself as well as subtrees.  Implies -r.\r
476 </p>\r
477 </dd>\r
478 <dt>\r
479 --root\r
480 </dt>\r
481 <dd>\r
482 <p>\r
483         When <em>--root</em> is specified the initial commit will be showed as a big\r
484         creation event. This is equivalent to a diff against the NULL tree.\r
485 </p>\r
486 </dd>\r
487 <dt>\r
488 --stdin\r
489 </dt>\r
490 <dd>\r
491 <p>\r
492         When <em>--stdin</em> is specified, the command does not take\r
493         &lt;tree-ish&gt; arguments from the command line.  Instead, it\r
494         reads either one &lt;commit&gt; or a pair of &lt;tree-ish&gt;\r
495         separated with a single space from its standard input.\r
496 </p>\r
497 <p>When a single commit is given on one line of such input, it compares\r
498 the commit with its parents.  The following flags further affects its\r
499 behaviour.  This does not apply to the case where two &lt;tree-ish&gt;\r
500 separated with a single space are given.</p>\r
501 </dd>\r
502 <dt>\r
503 -m\r
504 </dt>\r
505 <dd>\r
506 <p>\r
507         By default, "git-diff-tree --stdin" does not show\r
508         differences for merge commits.  With this flag, it shows\r
509         differences to that commit from all of its parents.\r
510 </p>\r
511 </dd>\r
512 <dt>\r
513 -s\r
514 </dt>\r
515 <dd>\r
516 <p>\r
517         By default, "git-diff-tree --stdin" shows differences,\r
518         either in machine-readable form (without <em>-p</em>) or in patch\r
519         form (with <em>-p</em>).  This output can be suppressed.  It is\r
520         only useful with <em>-v</em> flag.\r
521 </p>\r
522 </dd>\r
523 <dt>\r
524 -v\r
525 </dt>\r
526 <dd>\r
527 <p>\r
528         This flag causes "git-diff-tree --stdin" to also show\r
529         the commit message before the differences.\r
530 </p>\r
531 </dd>\r
532 <dt>\r
533 --pretty[=(raw|medium|short)]\r
534 </dt>\r
535 <dd>\r
536 <p>\r
537         This is used to control "pretty printing" format of the\r
538         commit message.  Without "=&lt;style&gt;", it defaults to\r
539         medium.\r
540 </p>\r
541 </dd>\r
542 <dt>\r
543 --no-commit-id\r
544 </dt>\r
545 <dd>\r
546 <p>\r
547         git-diff-tree outputs a line with the commit ID when\r
548         applicable.  This flag suppressed the commit ID output.\r
549 </p>\r
550 </dd>\r
551 <dt>\r
552 -c,--cc\r
553 </dt>\r
554 <dd>\r
555 <p>\r
556         These flags change the way a merge commit is displayed\r
557         (which means it is useful only when the command is given\r
558         one &lt;tree-ish&gt;, or <em>--stdin</em>).  It shows the differences\r
559         from each of the parents to the merge result\r
560         simultaneously, instead of showing pairwise diff between\r
561         a parent and the result one at a time, which <em>-m</em> option\r
562         output does.  <em>--cc</em> further compresses the output by\r
563         omiting hunks that show differences from only one\r
564         parent, or show the same change from all but one parent\r
565         for an Octopus merge.  When this optimization makes all\r
566         hunks disappear, the commit itself and the commit log\r
567         message is not shown, just like any other "empty diff" cases.\r
568 </p>\r
569 </dd>\r
570 </dl>\r
571 </div>\r
572 <h2>Limiting Output</h2>\r
573 <div class="sectionbody">\r
574 <p>If you're only interested in differences in a subset of files, for\r
575 example some architecture-specific files, you might do:</p>\r
576 <div class="literalblock">\r
577 <div class="content">\r
578 <pre><tt>git-diff-tree -r &lt;tree-ish&gt; &lt;tree-ish&gt; arch/ia64 include/asm-ia64</tt></pre>\r
579 </div></div>\r
580 <p>and it will only show you what changed in those two directories.</p>\r
581 <p>Or if you are searching for what changed in just <tt>kernel/sched.c</tt>, just do</p>\r
582 <div class="literalblock">\r
583 <div class="content">\r
584 <pre><tt>git-diff-tree -r &lt;tree-ish&gt; &lt;tree-ish&gt; kernel/sched.c</tt></pre>\r
585 </div></div>\r
586 <p>and it will ignore all differences to other files.</p>\r
587 <p>The pattern is always the prefix, and is matched exactly.  There are no\r
588 wildcards.  Even stricter, it has to match a complete path component.\r
589 I.e. "foo" does not pick up <tt>foobar.h</tt>.  "foo" does match <tt>foo/bar.h</tt>\r
590 so it can be used to name subdirectories.</p>\r
591 <p>An example of normal usage is:</p>\r
592 <div class="literalblock">\r
593 <div class="content">\r
594 <pre><tt>torvalds@ppc970:~/git&gt; git-diff-tree 5319e4......\r
595 *100664-&gt;100664 blob    ac348b.......-&gt;a01513.......      git-fsck-objects.c</tt></pre>\r
596 </div></div>\r
597 <p>which tells you that the last commit changed just one file (it's from\r
598 this one:</p>\r
599 <div class="listingblock">\r
600 <div class="content">\r
601 <pre><tt>commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8\r
602 tree 5319e4d609cdd282069cc4dce33c1db559539b03\r
603 parent b4e628ea30d5ab3606119d2ea5caeab141d38df7\r
604 author Linus Torvalds &lt;torvalds@ppc970.osdl.org&gt; Sat Apr 9 12:02:30 2005\r
605 committer Linus Torvalds &lt;torvalds@ppc970.osdl.org&gt; Sat Apr 9 12:02:30 2005\r
606 \r
607 Make "git-fsck-objects" print out all the root commits it finds.\r
608 \r
609 Once I do the reference tracking, I'll also make it print out all the\r
610 HEAD commits it finds, which is even more interesting.</tt></pre>\r
611 </div></div>\r
612 <p>in case you care).</p>\r
613 </div>\r
614 <h2>Output format</h2>\r
615 <div class="sectionbody">\r
616 <p>The output format from "git-diff-index", "git-diff-tree" and\r
617 "git-diff-files" are very similar.</p>\r
618 <p>These commands all compare two sets of things; what is\r
619 compared differs:</p>\r
620 <dl>\r
621 <dt>\r
622 git-diff-index &lt;tree-ish&gt;\r
623 </dt>\r
624 <dd>\r
625 <p>\r
626         compares the &lt;tree-ish&gt; and the files on the filesystem.\r
627 </p>\r
628 </dd>\r
629 <dt>\r
630 git-diff-index --cached &lt;tree-ish&gt;\r
631 </dt>\r
632 <dd>\r
633 <p>\r
634         compares the &lt;tree-ish&gt; and the index.\r
635 </p>\r
636 </dd>\r
637 <dt>\r
638 git-diff-tree [-r] &lt;tree-ish-1&gt; &lt;tree-ish-2&gt; [&lt;pattern&gt;&#8230;]\r
639 </dt>\r
640 <dd>\r
641 <p>\r
642         compares the trees named by the two arguments.\r
643 </p>\r
644 </dd>\r
645 <dt>\r
646 git-diff-files [&lt;pattern&gt;&#8230;]\r
647 </dt>\r
648 <dd>\r
649 <p>\r
650         compares the index and the files on the filesystem.\r
651 </p>\r
652 </dd>\r
653 </dl>\r
654 <p>An output line is formatted this way:</p>\r
655 <div class="listingblock">\r
656 <div class="content">\r
657 <pre><tt>in-place edit  :100644 100644 bcd1234... 0123456... M file0\r
658 copy-edit      :100644 100644 abcd123... 1234567... C68 file1 file2\r
659 rename-edit    :100644 100644 abcd123... 1234567... R86 file1 file3\r
660 create         :000000 100644 0000000... 1234567... A file4\r
661 delete         :100644 000000 1234567... 0000000... D file5\r
662 unmerged       :000000 000000 0000000... 0000000... U file6</tt></pre>\r
663 </div></div>\r
664 <p>That is, from the left to the right:</p>\r
665 <ol>\r
666 <li>\r
667 <p>\r
668 a colon.\r
669 </p>\r
670 </li>\r
671 <li>\r
672 <p>\r
673 mode for "src"; 000000 if creation or unmerged.\r
674 </p>\r
675 </li>\r
676 <li>\r
677 <p>\r
678 a space.\r
679 </p>\r
680 </li>\r
681 <li>\r
682 <p>\r
683 mode for "dst"; 000000 if deletion or unmerged.\r
684 </p>\r
685 </li>\r
686 <li>\r
687 <p>\r
688 a space.\r
689 </p>\r
690 </li>\r
691 <li>\r
692 <p>\r
693 sha1 for "src"; 0{40} if creation or unmerged.\r
694 </p>\r
695 </li>\r
696 <li>\r
697 <p>\r
698 a space.\r
699 </p>\r
700 </li>\r
701 <li>\r
702 <p>\r
703 sha1 for "dst"; 0{40} if creation, unmerged or "look at work tree".\r
704 </p>\r
705 </li>\r
706 <li>\r
707 <p>\r
708 a space.\r
709 </p>\r
710 </li>\r
711 <li>\r
712 <p>\r
713 status, followed by optional "score" number.\r
714 </p>\r
715 </li>\r
716 <li>\r
717 <p>\r
718 a tab or a NUL when <em>-z</em> option is used.\r
719 </p>\r
720 </li>\r
721 <li>\r
722 <p>\r
723 path for "src"\r
724 </p>\r
725 </li>\r
726 <li>\r
727 <p>\r
728 a tab or a NUL when <em>-z</em> option is used; only exists for C or R.\r
729 </p>\r
730 </li>\r
731 <li>\r
732 <p>\r
733 path for "dst"; only exists for C or R.\r
734 </p>\r
735 </li>\r
736 <li>\r
737 <p>\r
738 an LF or a NUL when <em>-z</em> option is used, to terminate the record.\r
739 </p>\r
740 </li>\r
741 </ol>\r
742 <p>&lt;sha1&gt; is shown as all 0's if a file is new on the filesystem\r
743 and it is out of sync with the index.</p>\r
744 <p>Example:</p>\r
745 <div class="listingblock">\r
746 <div class="content">\r
747 <pre><tt>:100644 100644 5be4a4...... 000000...... M file.c</tt></pre>\r
748 </div></div>\r
749 <p>When <tt>-z</tt> option is not used, TAB, LF, and backslash characters\r
750 in pathnames are represented as <tt>\t</tt>, <tt>\n</tt>, and <tt>\\</tt>,\r
751 respectively.</p>\r
752 </div>\r
753 <h2>Generating patches with -p</h2>\r
754 <div class="sectionbody">\r
755 <p>When "git-diff-index", "git-diff-tree", or "git-diff-files" are run\r
756 with a <em>-p</em> option, they do not produce the output described above;\r
757 instead they produce a patch file.</p>\r
758 <p>The patch generation can be customized at two levels.</p>\r
759 <ol>\r
760 <li>\r
761 <p>\r
762 When the environment variable <em>GIT_EXTERNAL_DIFF</em> is not set,\r
763    these commands internally invoke "diff" like this:\r
764 </p>\r
765 <div class="literalblock">\r
766 <div class="content">\r
767 <pre><tt>diff -L a/&lt;path&gt; -L b/&lt;path&gt; -pu &lt;old&gt; &lt;new&gt;</tt></pre>\r
768 </div></div>\r
769 <p>For added files, <tt>/dev/null</tt> is used for &lt;old&gt;.  For removed\r
770 files, <tt>/dev/null</tt> is used for &lt;new&gt;</p>\r
771 <p>The "diff" formatting options can be customized via the\r
772 environment variable <em>GIT_DIFF_OPTS</em>.  For example, if you\r
773 prefer context diff:</p>\r
774 <div class="literalblock">\r
775 <div class="content">\r
776 <pre><tt>GIT_DIFF_OPTS=-c git-diff-index -p HEAD</tt></pre>\r
777 </div></div>\r
778 </li>\r
779 <li>\r
780 <p>\r
781 When the environment variable <em>GIT_EXTERNAL_DIFF</em> is set, the\r
782    program named by it is called, instead of the diff invocation\r
783    described above.\r
784 </p>\r
785 <p>For a path that is added, removed, or modified,\r
786 <em>GIT_EXTERNAL_DIFF</em> is called with 7 parameters:</p>\r
787 <div class="literalblock">\r
788 <div class="content">\r
789 <pre><tt>path old-file old-hex old-mode new-file new-hex new-mode</tt></pre>\r
790 </div></div>\r
791 <p>where:</p>\r
792 <div class="hlist"><table>\r
793 <tr>\r
794 <td class="hlist1">\r
795 &lt;old|new&gt;-file\r
796 </td>\r
797 <td class="hlist2">\r
798 are files GIT_EXTERNAL_DIFF can use to read the\r
799                       contents of &lt;old|new&gt;,\r
800 </td>\r
801 </tr>\r
802 <tr>\r
803 <td class="hlist1">\r
804 &lt;old|new&gt;-hex\r
805 </td>\r
806 <td class="hlist2">\r
807 are the 40-hexdigit SHA1 hashes,\r
808 </td>\r
809 </tr>\r
810 <tr>\r
811 <td class="hlist1">\r
812 &lt;old|new&gt;-mode\r
813 </td>\r
814 <td class="hlist2">\r
815 are the octal representation of the file modes.\r
816 </td>\r
817 </tr>\r
818 </table></div>\r
819 <p>The file parameters can point at the user's working file\r
820 (e.g. <tt>new-file</tt> in "git-diff-files"), <tt>/dev/null</tt> (e.g. <tt>old-file</tt>\r
821 when a new file is added), or a temporary file (e.g. <tt>old-file</tt> in the\r
822 index).  <em>GIT_EXTERNAL_DIFF</em> should not worry about unlinking the\r
823 temporary file --- it is removed when <em>GIT_EXTERNAL_DIFF</em> exits.</p>\r
824 </li>\r
825 </ol>\r
826 <p>For a path that is unmerged, <em>GIT_EXTERNAL_DIFF</em> is called with 1\r
827 parameter, &lt;path&gt;.</p>\r
828 </div>\r
829 <h2>git specific extension to diff format</h2>\r
830 <div class="sectionbody">\r
831 <p>What -p option produces is slightly different from the\r
832 traditional diff format.</p>\r
833 <ol>\r
834 <li>\r
835 <p>\r
836 It is preceded with a "git diff" header, that looks like\r
837      this:\r
838 </p>\r
839 <div class="literalblock">\r
840 <div class="content">\r
841 <pre><tt>diff --git a/file1 b/file2</tt></pre>\r
842 </div></div>\r
843 <p>The <tt>a/</tt> and <tt>b/</tt> filenames are the same unless rename/copy is\r
844 involved.  Especially, even for a creation or a deletion,\r
845 <tt>/dev/null</tt> is _not_ used in place of <tt>a/</tt> or <tt>b/</tt> filenames.</p>\r
846 <p>When rename/copy is involved, <tt>file1</tt> and <tt>file2</tt> show the\r
847 name of the source file of the rename/copy and the name of\r
848 the file that rename/copy produces, respectively.</p>\r
849 </li>\r
850 <li>\r
851 <p>\r
852 It is followed by one or more extended header lines:\r
853 </p>\r
854 <div class="literalblock">\r
855 <div class="content">\r
856 <pre><tt>old mode &lt;mode&gt;\r
857 new mode &lt;mode&gt;\r
858 deleted file mode &lt;mode&gt;\r
859 new file mode &lt;mode&gt;\r
860 copy from &lt;path&gt;\r
861 copy to &lt;path&gt;\r
862 rename from &lt;path&gt;\r
863 rename to &lt;path&gt;\r
864 similarity index &lt;number&gt;\r
865 dissimilarity index &lt;number&gt;\r
866 index &lt;hash&gt;..&lt;hash&gt; &lt;mode&gt;</tt></pre>\r
867 </div></div>\r
868 </li>\r
869 <li>\r
870 <p>\r
871 TAB, LF, and backslash characters in pathnames are\r
872     represented as <tt>\t</tt>, <tt>\n</tt>, and <tt>\\</tt>, respectively.\r
873 </p>\r
874 </li>\r
875 </ol>\r
876 </div>\r
877 <h2>combined diff format</h2>\r
878 <div class="sectionbody">\r
879 <p>git-diff-tree and git-diff-files can take <em>-c</em> or <em>--cc</em> option\r
880 to produce <em>combined diff</em>, which looks like this:</p>\r
881 <div class="listingblock">\r
882 <div class="content">\r
883 <pre><tt>diff --combined describe.c\r
884 @@@ +98,7 @@@\r
885    return (a_date &gt; b_date) ? -1 : (a_date == b_date) ? 0 : 1;\r
886   }\r
887 \r
888 - static void describe(char *arg)\r
889  -static void describe(struct commit *cmit, int last_one)\r
890 ++static void describe(char *arg, int last_one)\r
891   {\r
892  +     unsigned char sha1[20];\r
893  +     struct commit *cmit;</tt></pre>\r
894 </div></div>\r
895 <p>Unlike the traditional <em>unified</em> diff format, which shows two\r
896 files A and B with a single column that has <tt>-</tt> (minus &#8212;\r
897 appears in A but removed in B), <tt>+</tt> (plus &#8212; missing in A but\r
898 added to B), or <tt> </tt> (space &#8212; unchanged) prefix, this format\r
899 compares two or more files file1, file2,&#8230; with one file X, and\r
900 shows how X differs from each of fileN.  One column for each of\r
901 fileN is prepended to the output line to note how X's line is\r
902 different from it.</p>\r
903 <p>A <tt>-</tt> character in the column N means that the line appears in\r
904 fileN but it does not appear in the last file.  A <tt>+</tt> character\r
905 in the column N means that the line appears in the last file,\r
906 and fileN does not have that line.</p>\r
907 <p>In the above example output, the function signature was changed\r
908 from both files (hence two <tt>-</tt> removals from both file1 and\r
909 file2, plus <tt>++</tt> to mean one line that was added does not appear\r
910 in either file1 nor file2).  Also two other lines are the same\r
911 from file1 but do not appear in file2 (hence prefixed with <tt> +</tt>).</p>\r
912 <p>When shown by <tt>git diff-tree -c</tt>, it compares the parents of a\r
913 merge commit with the merge result (i.e. file1..fileN are the\r
914 parents).  When shown by <tt>git diff-files -c</tt>, it compares the\r
915 two unresolved merge parents with the working tree file\r
916 (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka\r
917 "their version").</p>\r
918 </div>\r
919 <h2>Author</h2>\r
920 <div class="sectionbody">\r
921 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
922 </div>\r
923 <h2>Documentation</h2>\r
924 <div class="sectionbody">\r
925 <p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
926 </div>\r
927 <h2>GIT</h2>\r
928 <div class="sectionbody">\r
929 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
930 </div>\r
931 <div id="footer">\r
932 <div id="footer-text">\r
933 Last updated 02-Feb-2006 15:49:55 PDT\r
934 </div>\r
935 </div>\r
936 </body>\r
937 </html>\r