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
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
\r
6 <meta name="generator" content="AsciiDoc 7.0.2" />
\r
7 <style type="text/css">
\r
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
\r
11 border: 1px solid red;
\r
16 margin: 1em 5% 1em 5%;
\r
20 a:visited { color: fuchsia; }
\r
34 h1, h2, h3, h4, h5, h6 {
\r
36 font-family: sans-serif;
\r
38 margin-bottom: 0.5em;
\r
43 border-bottom: 2px solid silver;
\r
46 border-bottom: 2px solid silver;
\r
56 border: 1px solid silver;
\r
61 margin-bottom: 0.5em;
\r
71 font-family: sans-serif;
\r
78 font-family: sans-serif;
\r
82 font-family: sans-serif;
\r
84 border-top: 2px solid silver;
\r
90 padding-bottom: 0.5em;
\r
94 padding-bottom: 0.5em;
\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
103 margin-bottom: 1.5em;
\r
105 div.admonitionblock {
\r
107 margin-bottom: 2.5em;
\r
110 div.content { /* Block element content. */
\r
114 /* Block element titles. */
\r
115 div.title, caption.title {
\r
116 font-family: sans-serif;
\r
120 margin-bottom: 0.5em;
\r
126 td div.title:first-child {
\r
129 div.content div.title:first-child {
\r
132 div.content + div.title {
\r
136 div.sidebarblock > div.content {
\r
137 background: #ffffee;
\r
138 border: 1px solid silver;
\r
142 div.listingblock > div.content {
\r
143 border: 1px solid silver;
\r
144 background: #f4f4f4;
\r
148 div.quoteblock > div.content {
\r
149 padding-left: 2.0em;
\r
151 div.quoteblock .attribution {
\r
155 div.admonitionblock .icon {
\r
156 vertical-align: top;
\r
159 text-decoration: underline;
\r
161 padding-right: 0.5em;
\r
163 div.admonitionblock td.content {
\r
164 padding-left: 0.5em;
\r
165 border-left: 2px solid silver;
\r
168 div.exampleblock > div.content {
\r
169 border-left: 2px solid silver;
\r
173 div.verseblock div.content {
\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
183 margin-bottom: 0.8em;
\r
188 font-style: italic;
\r
190 dd > *:first-child {
\r
195 list-style-position: outside;
\r
198 list-style-type: lower-alpha;
\r
201 div.tableblock > table {
\r
202 border-color: #527bbd;
\r
206 font-family: sans-serif;
\r
215 margin-bottom: 0.8em;
\r
218 vertical-align: top;
\r
219 font-style: italic;
\r
220 padding-right: 0.8em;
\r
223 vertical-align: top;
\r
227 div#footer-badges { display: none; }
\r
229 include::./stylesheets/xhtml11-manpage.css[]
\r
230 /* Workarounds for IE6's broken and incomplete CSS2. */
\r
232 div.sidebar-content {
\r
233 background: #ffffee;
\r
234 border: 1px solid silver;
\r
237 div.sidebar-title, div.image-title {
\r
238 font-family: sans-serif;
\r
241 margin-bottom: 0.5em;
\r
244 div.listingblock div.content {
\r
245 border: 1px solid silver;
\r
246 background: #f4f4f4;
\r
250 div.quoteblock-content {
\r
251 padding-left: 2.0em;
\r
254 div.exampleblock-content {
\r
255 border-left: 2px solid silver;
\r
256 padding-left: 0.5em;
\r
259 <title>git-diff-index(1)</title>
\r
264 git-diff-index(1) Manual Page
\r
267 <div class="sectionbody">
\r
268 <p>git-diff-index -
\r
269 Compares content and mode of blobs between the index and repository
\r
274 <div class="sectionbody">
\r
275 <p><em>git-diff-index</em> [-m] [--cached] [<common diff options>] <tree-ish> [<path>…]</p>
\r
277 <h2>DESCRIPTION</h2>
\r
278 <div class="sectionbody">
\r
279 <p>Compares the content and mode of the blobs found via a tree
\r
280 object with the content of the current index and, optionally
\r
281 ignoring the stat state of the file on disk. When paths are
\r
282 specified, compares only those named paths. Otherwise all
\r
283 entries in the index are compared.</p>
\r
286 <div class="sectionbody">
\r
293 Generate patch (see section on generating patches)
\r
309 Generate patch but keep also the default raw diff output.
\r
317 Generate a diffstat instead of a patch.
\r
325 Output a condensed summary of extended header information
\r
326 such as creations, renames and mode changes.
\r
334 Generate patch and prepend its diffstat.
\r
342 \0 line termination on output
\r
350 Show only names of changed files.
\r
358 Show only names and status of changed files.
\r
366 Instead of the first handful characters, show full
\r
367 object name of pre- and post-image blob on the "index"
\r
368 line when generating a patch format output.
\r
372 --abbrev[=<n>]
\r
376 Instead of showing the full 40-byte hexadecimal object
\r
377 name in diff-raw format output and diff-tree header
\r
378 lines, show only handful hexdigits prefix. This is
\r
379 independent of --full-index option above, which controls
\r
380 the diff-patch output format. Non default number of
\r
381 digits can be specified with --abbrev=<n>.
\r
389 Break complete rewrite changes into pairs of delete and create.
\r
405 Detect copies as well as renames.
\r
409 --diff-filter=[ACDMRTUXB*]
\r
413 Select only files that are Added (<tt>A</tt>), Copied (<tt>C</tt>),
\r
414 Deleted (<tt>D</tt>), Modified (<tt>M</tt>), Renamed (<tt>R</tt>), have their
\r
415 type (mode) changed (<tt>T</tt>), are Unmerged (<tt>U</tt>), are
\r
416 Unknown (<tt>X</tt>), or have had their pairing Broken (<tt>B</tt>).
\r
417 Any combination of the filter characters may be used.
\r
418 When <tt>*</tt> (All-or-none) is added to the combination, all
\r
419 paths are selected if there is any file that matches
\r
420 other criteria in the comparison; if there is no file
\r
421 that matches other criteria, nothing is selected.
\r
425 --find-copies-harder
\r
429 For performance reasons, by default, -C option finds copies only
\r
430 if the original file of the copy was modified in the same
\r
431 changeset. This flag makes the command
\r
432 inspect unmodified files as candidates for the source of
\r
433 copy. This is a very expensive operation for large
\r
434 projects, so use it with caution.
\r
442 -M and -C options require O(n^2) processing time where n
\r
443 is the number of potential rename/copy targets. This
\r
444 option prevents rename/copy detection from running if
\r
445 the number of rename/copy targets exceeds the specified
\r
454 Look for differences that contain the change in <string>.
\r
462 When -S finds a change, show all the changes in that
\r
463 changeset, not just the files that contain the change
\r
472 Make the <string> not a plain string but an extended POSIX
\r
477 -O<orderfile>
\r
481 Output the patch in the order specified in the
\r
482 <orderfile>, which has one shell glob pattern per line.
\r
490 Swap two inputs; that is, show differences from index or
\r
491 on-disk file to tree contents.
\r
495 <p>For more detailed explanation on these common options, see also
\r
496 <a href="diffcore.html">diffcore documentation</a>.</p>
\r
503 The id of a tree object to diff against.
\r
511 do not consider the on-disk file at all
\r
519 By default, files recorded in the index but not checked
\r
520 out are reported as deleted. This flag makes
\r
521 "git-diff-index" say that all non-checked-out files are up
\r
527 <h2>Output format</h2>
\r
528 <div class="sectionbody">
\r
529 <p>The output format from "git-diff-index", "git-diff-tree" and
\r
530 "git-diff-files" are very similar.</p>
\r
531 <p>These commands all compare two sets of things; what is
\r
532 compared differs:</p>
\r
535 git-diff-index <tree-ish>
\r
539 compares the <tree-ish> and the files on the filesystem.
\r
543 git-diff-index --cached <tree-ish>
\r
547 compares the <tree-ish> and the index.
\r
551 git-diff-tree [-r] <tree-ish-1> <tree-ish-2> [<pattern>…]
\r
555 compares the trees named by the two arguments.
\r
559 git-diff-files [<pattern>…]
\r
563 compares the index and the files on the filesystem.
\r
567 <p>An output line is formatted this way:</p>
\r
568 <div class="listingblock">
\r
569 <div class="content">
\r
570 <pre><tt>in-place edit :100644 100644 bcd1234... 0123456... M file0
\r
571 copy-edit :100644 100644 abcd123... 1234567... C68 file1 file2
\r
572 rename-edit :100644 100644 abcd123... 1234567... R86 file1 file3
\r
573 create :000000 100644 0000000... 1234567... A file4
\r
574 delete :100644 000000 1234567... 0000000... D file5
\r
575 unmerged :000000 000000 0000000... 0000000... U file6</tt></pre>
\r
577 <p>That is, from the left to the right:</p>
\r
586 mode for "src"; 000000 if creation or unmerged.
\r
596 mode for "dst"; 000000 if deletion or unmerged.
\r
606 sha1 for "src"; 0{40} if creation or unmerged.
\r
616 sha1 for "dst"; 0{40} if creation, unmerged or "look at work tree".
\r
626 status, followed by optional "score" number.
\r
631 a tab or a NUL when <em>-z</em> option is used.
\r
641 a tab or a NUL when <em>-z</em> option is used; only exists for C or R.
\r
646 path for "dst"; only exists for C or R.
\r
651 an LF or a NUL when <em>-z</em> option is used, to terminate the record.
\r
655 <p><sha1> is shown as all 0's if a file is new on the filesystem
\r
656 and it is out of sync with the index.</p>
\r
658 <div class="listingblock">
\r
659 <div class="content">
\r
660 <pre><tt>:100644 100644 5be4a4...... 000000...... M file.c</tt></pre>
\r
662 <p>When <tt>-z</tt> option is not used, TAB, LF, and backslash characters
\r
663 in pathnames are represented as <tt>\t</tt>, <tt>\n</tt>, and <tt>\\</tt>,
\r
666 <h2>Generating patches with -p</h2>
\r
667 <div class="sectionbody">
\r
668 <p>When "git-diff-index", "git-diff-tree", or "git-diff-files" are run
\r
669 with a <em>-p</em> option, they do not produce the output described above;
\r
670 instead they produce a patch file.</p>
\r
671 <p>The patch generation can be customized at two levels.</p>
\r
675 When the environment variable <em>GIT_EXTERNAL_DIFF</em> is not set,
\r
676 these commands internally invoke "diff" like this:
\r
678 <div class="literalblock">
\r
679 <div class="content">
\r
680 <pre><tt>diff -L a/<path> -L b/<path> -pu <old> <new></tt></pre>
\r
682 <p>For added files, <tt>/dev/null</tt> is used for <old>. For removed
\r
683 files, <tt>/dev/null</tt> is used for <new></p>
\r
684 <p>The "diff" formatting options can be customized via the
\r
685 environment variable <em>GIT_DIFF_OPTS</em>. For example, if you
\r
686 prefer context diff:</p>
\r
687 <div class="literalblock">
\r
688 <div class="content">
\r
689 <pre><tt>GIT_DIFF_OPTS=-c git-diff-index -p HEAD</tt></pre>
\r
694 When the environment variable <em>GIT_EXTERNAL_DIFF</em> is set, the
\r
695 program named by it is called, instead of the diff invocation
\r
698 <p>For a path that is added, removed, or modified,
\r
699 <em>GIT_EXTERNAL_DIFF</em> is called with 7 parameters:</p>
\r
700 <div class="literalblock">
\r
701 <div class="content">
\r
702 <pre><tt>path old-file old-hex old-mode new-file new-hex new-mode</tt></pre>
\r
705 <div class="hlist"><table>
\r
707 <td class="hlist1">
\r
708 <old|new>-file
\r
710 <td class="hlist2">
\r
711 are files GIT_EXTERNAL_DIFF can use to read the
\r
712 contents of <old|new>,
\r
716 <td class="hlist1">
\r
717 <old|new>-hex
\r
719 <td class="hlist2">
\r
720 are the 40-hexdigit SHA1 hashes,
\r
724 <td class="hlist1">
\r
725 <old|new>-mode
\r
727 <td class="hlist2">
\r
728 are the octal representation of the file modes.
\r
732 <p>The file parameters can point at the user's working file
\r
733 (e.g. <tt>new-file</tt> in "git-diff-files"), <tt>/dev/null</tt> (e.g. <tt>old-file</tt>
\r
734 when a new file is added), or a temporary file (e.g. <tt>old-file</tt> in the
\r
735 index). <em>GIT_EXTERNAL_DIFF</em> should not worry about unlinking the
\r
736 temporary file --- it is removed when <em>GIT_EXTERNAL_DIFF</em> exits.</p>
\r
739 <p>For a path that is unmerged, <em>GIT_EXTERNAL_DIFF</em> is called with 1
\r
740 parameter, <path>.</p>
\r
742 <h2>git specific extension to diff format</h2>
\r
743 <div class="sectionbody">
\r
744 <p>What -p option produces is slightly different from the
\r
745 traditional diff format.</p>
\r
749 It is preceded with a "git diff" header, that looks like
\r
752 <div class="literalblock">
\r
753 <div class="content">
\r
754 <pre><tt>diff --git a/file1 b/file2</tt></pre>
\r
756 <p>The <tt>a/</tt> and <tt>b/</tt> filenames are the same unless rename/copy is
\r
757 involved. Especially, even for a creation or a deletion,
\r
758 <tt>/dev/null</tt> is _not_ used in place of <tt>a/</tt> or <tt>b/</tt> filenames.</p>
\r
759 <p>When rename/copy is involved, <tt>file1</tt> and <tt>file2</tt> show the
\r
760 name of the source file of the rename/copy and the name of
\r
761 the file that rename/copy produces, respectively.</p>
\r
765 It is followed by one or more extended header lines:
\r
767 <div class="literalblock">
\r
768 <div class="content">
\r
769 <pre><tt>old mode <mode>
\r
770 new mode <mode>
\r
771 deleted file mode <mode>
\r
772 new file mode <mode>
\r
773 copy from <path>
\r
774 copy to <path>
\r
775 rename from <path>
\r
776 rename to <path>
\r
777 similarity index <number>
\r
778 dissimilarity index <number>
\r
779 index <hash>..<hash> <mode></tt></pre>
\r
784 TAB, LF, and backslash characters in pathnames are
\r
785 represented as <tt>\t</tt>, <tt>\n</tt>, and <tt>\\</tt>, respectively.
\r
790 <h2>combined diff format</h2>
\r
791 <div class="sectionbody">
\r
792 <p>git-diff-tree and git-diff-files can take <em>-c</em> or <em>--cc</em> option
\r
793 to produce <em>combined diff</em>, which looks like this:</p>
\r
794 <div class="listingblock">
\r
795 <div class="content">
\r
796 <pre><tt>diff --combined describe.c
\r
798 return (a_date > b_date) ? -1 : (a_date == b_date) ? 0 : 1;
\r
801 - static void describe(char *arg)
\r
802 -static void describe(struct commit *cmit, int last_one)
\r
803 ++static void describe(char *arg, int last_one)
\r
805 + unsigned char sha1[20];
\r
806 + struct commit *cmit;</tt></pre>
\r
808 <p>Unlike the traditional <em>unified</em> diff format, which shows two
\r
809 files A and B with a single column that has <tt>-</tt> (minus —
\r
810 appears in A but removed in B), <tt>+</tt> (plus — missing in A but
\r
811 added to B), or <tt> </tt> (space — unchanged) prefix, this format
\r
812 compares two or more files file1, file2,… with one file X, and
\r
813 shows how X differs from each of fileN. One column for each of
\r
814 fileN is prepended to the output line to note how X's line is
\r
815 different from it.</p>
\r
816 <p>A <tt>-</tt> character in the column N means that the line appears in
\r
817 fileN but it does not appear in the last file. A <tt>+</tt> character
\r
818 in the column N means that the line appears in the last file,
\r
819 and fileN does not have that line.</p>
\r
820 <p>In the above example output, the function signature was changed
\r
821 from both files (hence two <tt>-</tt> removals from both file1 and
\r
822 file2, plus <tt>++</tt> to mean one line that was added does not appear
\r
823 in either file1 nor file2). Also two other lines are the same
\r
824 from file1 but do not appear in file2 (hence prefixed with <tt> +</tt>).</p>
\r
825 <p>When shown by <tt>git diff-tree -c</tt>, it compares the parents of a
\r
826 merge commit with the merge result (i.e. file1..fileN are the
\r
827 parents). When shown by <tt>git diff-files -c</tt>, it compares the
\r
828 two unresolved merge parents with the working tree file
\r
829 (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka
\r
830 "their version").</p>
\r
832 <h2>Operating Modes</h2>
\r
833 <div class="sectionbody">
\r
834 <p>You can choose whether you want to trust the index file entirely
\r
835 (using the <em>--cached</em> flag) or ask the diff logic to show any files
\r
836 that don't match the stat state as being "tentatively changed". Both
\r
837 of these operations are very useful indeed.</p>
\r
839 <h2>Cached Mode</h2>
\r
840 <div class="sectionbody">
\r
841 <p>If <em>--cached</em> is specified, it allows you to ask:</p>
\r
842 <div class="literalblock">
\r
843 <div class="content">
\r
844 <pre><tt>show me the differences between HEAD and the current index
\r
845 contents (the ones I'd write with a "git-write-tree")</tt></pre>
\r
847 <p>For example, let's say that you have worked on your working directory, updated
\r
848 some files in the index and are ready to commit. You want to see exactly
\r
849 <strong>what</strong> you are going to commit is without having to write a new tree
\r
850 object and compare it that way, and to do that, you just do</p>
\r
851 <div class="literalblock">
\r
852 <div class="content">
\r
853 <pre><tt>git-diff-index --cached HEAD</tt></pre>
\r
855 <p>Example: let's say I had renamed <tt>commit.c</tt> to <tt>git-commit.c</tt>, and I had
\r
856 done an "git-update-index" to make that effective in the index file.
\r
857 "git-diff-files" wouldn't show anything at all, since the index file
\r
858 matches my working directory. But doing a "git-diff-index" does:</p>
\r
859 <div class="literalblock">
\r
860 <div class="content">
\r
861 <pre><tt>torvalds@ppc970:~/git> git-diff-index --cached HEAD
\r
862 -100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 commit.c
\r
863 +100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 git-commit.c</tt></pre>
\r
865 <p>You can trivially see that the above is a rename.</p>
\r
866 <p>In fact, "git-diff-index --cached" <strong>should</strong> always be entirely equivalent to
\r
867 actually doing a "git-write-tree" and comparing that. Except this one is much
\r
868 nicer for the case where you just want to check where you are.</p>
\r
869 <p>So doing a "git-diff-index --cached" is basically very useful when you are
\r
870 asking yourself "what have I already marked for being committed, and
\r
871 what's the difference to a previous tree".</p>
\r
873 <h2>Non-cached Mode</h2>
\r
874 <div class="sectionbody">
\r
875 <p>The "non-cached" mode takes a different approach, and is potentially
\r
876 the more useful of the two in that what it does can't be emulated with
\r
877 a "git-write-tree" + "git-diff-tree". Thus that's the default mode.
\r
878 The non-cached version asks the question:</p>
\r
879 <div class="literalblock">
\r
880 <div class="content">
\r
881 <pre><tt>show me the differences between HEAD and the currently checked out
\r
882 tree - index contents _and_ files that aren't up-to-date</tt></pre>
\r
884 <p>which is obviously a very useful question too, since that tells you what
\r
885 you <strong>could</strong> commit. Again, the output matches the "git-diff-tree -r"
\r
886 output to a tee, but with a twist.</p>
\r
887 <p>The twist is that if some file doesn't match the index, we don't have
\r
888 a backing store thing for it, and we use the magic "all-zero" sha1 to
\r
889 show that. So let's say that you have edited <tt>kernel/sched.c</tt>, but
\r
890 have not actually done a "git-update-index" on it yet - there is no
\r
891 "object" associated with the new state, and you get:</p>
\r
892 <div class="literalblock">
\r
893 <div class="content">
\r
894 <pre><tt>torvalds@ppc970:~/v2.6/linux> git-diff-index HEAD
\r
895 *100644->100664 blob 7476bb......->000000...... kernel/sched.c</tt></pre>
\r
897 <p>i.e., it shows that the tree has changed, and that <tt>kernel/sched.c</tt> has is
\r
898 not up-to-date and may contain new stuff. The all-zero sha1 means that to
\r
899 get the real diff, you need to look at the object in the working directory
\r
900 directly rather than do an object-to-object diff.</p>
\r
901 <div class="admonitionblock">
\r
904 <div class="title">Note</div>
\r
906 <td class="content">As with other commands of this type, "git-diff-index" does not
\r
907 actually look at the contents of the file at all. So maybe
\r
908 <tt>kernel/sched.c</tt> hasn't actually changed, and it's just that you
\r
909 touched it. In either case, it's a note that you need to
\r
910 "git-update-index" it to make the index be in sync.</td>
\r
913 <div class="admonitionblock">
\r
916 <div class="title">Note</div>
\r
918 <td class="content">You can have a mixture of files show up as "has been updated"
\r
919 and "is still dirty in the working directory" together. You can always
\r
920 tell which file is in which state, since the "has been updated" ones
\r
921 show a valid sha1, and the "not in sync with the index" ones will
\r
922 always have the special all-zero sha1.</td>
\r
927 <div class="sectionbody">
\r
928 <p>Written by Linus Torvalds <torvalds@osdl.org></p>
\r
930 <h2>Documentation</h2>
\r
931 <div class="sectionbody">
\r
932 <p>Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.</p>
\r
935 <div class="sectionbody">
\r
936 <p>Part of the <a href="git.html">git(7)</a> suite</p>
\r
939 <div id="footer-text">
\r
940 Last updated 04-Jun-2006 07:24:24 UTC
\r
projects / git.git / blob