Include diff options in the git-log manpage
[git/git.git] / Documentation / diff-format.txt
1 The output format from "git-diff-index", "git-diff-tree",
2 "git-diff-files" and "git diff --raw" are very similar.
3
4 These commands all compare two sets of things; what is
5 compared differs:
6
7 git-diff-index <tree-ish>::
8 compares the <tree-ish> and the files on the filesystem.
9
10 git-diff-index --cached <tree-ish>::
11 compares the <tree-ish> and the index.
12
13 git-diff-tree [-r] <tree-ish-1> <tree-ish-2> [<pattern>...]::
14 compares the trees named by the two arguments.
15
16 git-diff-files [<pattern>...]::
17 compares the index and the files on the filesystem.
18
19
20 An output line is formatted this way:
21
22 ------------------------------------------------
23 in-place edit :100644 100644 bcd1234... 0123456... M file0
24 copy-edit :100644 100644 abcd123... 1234567... C68 file1 file2
25 rename-edit :100644 100644 abcd123... 1234567... R86 file1 file3
26 create :000000 100644 0000000... 1234567... A file4
27 delete :100644 000000 1234567... 0000000... D file5
28 unmerged :000000 000000 0000000... 0000000... U file6
29 ------------------------------------------------
30
31 That is, from the left to the right:
32
33 . a colon.
34 . mode for "src"; 000000 if creation or unmerged.
35 . a space.
36 . mode for "dst"; 000000 if deletion or unmerged.
37 . a space.
38 . sha1 for "src"; 0\{40\} if creation or unmerged.
39 . a space.
40 . sha1 for "dst"; 0\{40\} if creation, unmerged or "look at work tree".
41 . a space.
42 . status, followed by optional "score" number.
43 . a tab or a NUL when '-z' option is used.
44 . path for "src"
45 . a tab or a NUL when '-z' option is used; only exists for C or R.
46 . path for "dst"; only exists for C or R.
47 . an LF or a NUL when '-z' option is used, to terminate the record.
48
49 <sha1> is shown as all 0's if a file is new on the filesystem
50 and it is out of sync with the index.
51
52 Example:
53
54 ------------------------------------------------
55 :100644 100644 5be4a4...... 000000...... M file.c
56 ------------------------------------------------
57
58 When `-z` option is not used, TAB, LF, and backslash characters
59 in pathnames are represented as `\t`, `\n`, and `\\`,
60 respectively.
61
62 diff format for merges
63 ----------------------
64
65 "git-diff-tree", "git-diff-files" and "git-diff --raw"
66 can take '-c' or '--cc' option
67 to generate diff output also for merge commits. The output differs
68 from the format described above in the following way:
69
70 . there is a colon for each parent
71 . there are more "src" modes and "src" sha1
72 . status is concatenated status characters for each parent
73 . no optional "score" number
74 . single path, only for "dst"
75
76 Example:
77
78 ------------------------------------------------
79 ::100644 100644 100644 fabadb8... cc95eb0... 4866510... MM describe.c
80 ------------------------------------------------
81
82 Note that 'combined diff' lists only files which were modified from
83 all parents.
84
85
86 include::diff-generate-patch.txt[]