X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fdiff-format.txt;h=d1d0d2d3dc8760a8030313de3dd14a942d0fc2bf;hb=794f9fe7db30e2aff8f8f0543c6d18bf579cdbc2;hp=f85a605f0a336f506cf5cf46476a43e4c56b3e66;hpb=b6d8f309d9bbd8193d9b73eb41c6fcdaa8001298;p=git.git diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt index f85a605f..d1d0d2d3 100644 --- a/Documentation/diff-format.txt +++ b/Documentation/diff-format.txt @@ -1,13 +1,13 @@ -The output format from "git-diff-cache", "git-diff-tree" and -"git-diff-files" is very similar. +The output format from "git-diff-index", "git-diff-tree" and +"git-diff-files" are very similar. -These commands all compare two sets of things; what are -compared are different: +These commands all compare two sets of things; what is +compared differs: -git-diff-cache :: +git-diff-index :: compares the and the files on the filesystem. -git-diff-cache --cached :: +git-diff-index --cached :: compares the and the cache. git-diff-tree [-r] [...]:: @@ -19,49 +19,60 @@ git-diff-files [...]:: An output line is formatted this way: +------------------------------------------------ in-place edit :100644 100644 bcd1234... 0123456... M file0 copy-edit :100644 100644 abcd123... 1234567... C68 file1 file2 rename-edit :100644 100644 abcd123... 1234567... R86 file1 file3 -create :000000 100644 0000000... 1234567... N file4 +create :000000 100644 0000000... 1234567... A file4 delete :100644 000000 1234567... 0000000... D file5 unmerged :000000 000000 0000000... 0000000... U file6 +------------------------------------------------ That is, from the left to the right: - (1) a colon. - (2) mode for "src"; 000000 if creation or unmerged. - (3) a space. - (4) mode for "dst"; 000000 if deletion or unmerged. - (5) a space. - (6) sha1 for "src"; 0{40} if creation or unmerged. - (7) a space. - (8) sha1 for "dst"; 0{40} if creation, unmerged or "look at work tree". - (9) status, followed by similarlity index number only for C and R. - (10) a tab or a NUL when '-z' option is used. - (11) path for "src" - (12) a tab or a NUL when '-z' option is used; only exists for C or R. - (13) path for "dst"; only exists for C or R. - (14) an LF or a NUL when '-z' option is used, to terminate the record. - - is shown as all 0's if new is a file on the filesystem -and it is out of sync with the cache. Example: - - :100644 100644 5be4a4...... 000000...... M file.c +. a colon. +. mode for "src"; 000000 if creation or unmerged. +. a space. +. mode for "dst"; 000000 if deletion or unmerged. +. a space. +. sha1 for "src"; 0\{40\} if creation or unmerged. +. a space. +. sha1 for "dst"; 0\{40\} if creation, unmerged or "look at work tree". +. a space. +. status, followed by optional "score" number. +. a tab or a NUL when '-z' option is used. +. path for "src" +. a tab or a NUL when '-z' option is used; only exists for C or R. +. path for "dst"; only exists for C or R. +. an LF or a NUL when '-z' option is used, to terminate the record. + + is shown as all 0's if a file is new on the filesystem +and it is out of sync with the cache. + +Example: + +------------------------------------------------ +:100644 100644 5be4a4...... 000000...... M file.c +------------------------------------------------ + +When `-z` option is not used, TAB, LF, and backslash characters +in pathnames are represented as `\t`, `\n`, and `\\`, +respectively. + Generating patches with -p -------------------------- -When "git-diff-cache", "git-diff-tree", or "git-diff-files" are run -with a '-p' option, they do not produce the output described above +When "git-diff-index", "git-diff-tree", or "git-diff-files" are run +with a '-p' option, they do not produce the output described above; instead they produce a patch file. -The patch generation can be customized at two levels. This -customization also applies to "git-diff-helper". +The patch generation can be customized at two levels. 1. When the environment variable 'GIT_EXTERNAL_DIFF' is not set, these commands internally invoke "diff" like this: - diff -L a/ -L a/ -pu + diff -L a/ -L b/ -pu + For added files, `/dev/null` is used for . For removed files, `/dev/null` is used for @@ -70,7 +81,7 @@ The "diff" formatting options can be customized via the environment variable 'GIT_DIFF_OPTS'. For example, if you prefer context diff: - GIT_DIFF_OPTS=-c git-diff-cache -p $(cat .git/HEAD) + GIT_DIFF_OPTS=-c git-diff-index -p $(cat .git/HEAD) 2. When the environment variable 'GIT_EXTERNAL_DIFF' is set, the @@ -85,7 +96,7 @@ For a path that is added, removed, or modified, where: -file:: are files GIT_EXTERNAL_DIFF can use to read the - contents of , + contents of , -hex:: are the 40-hexdigit SHA1 hashes, -mode:: are the octal representation of the file modes. @@ -98,3 +109,40 @@ temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits. For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1 parameter, . + + +git specific extension to diff format +------------------------------------- + +What -p option produces is slightly different from the +traditional diff format. + +1. It is preceeded with a "git diff" header, that looks like + this: + + diff --git a/file1 b/file2 ++ +The `a/` and `b/` filenames are the same unless rename/copy is +involved. Especially, even for a creation or a deletion, +`/dev/null` is _not_ used in place of `a/` or `b/` filenames. ++ +When rename/copy is involved, `file1` and `file2` show the +name of the source file of the rename/copy and the name of +the file that rename/copy produces, respectively. + +2. It is followed by one or more extended header lines: + + old mode + new mode + deleted file mode + new file mode + copy from + copy to + rename from + rename to + similarity index + dissimilarity index + index .. + +3. TAB, LF, and backslash characters in pathnames are + represented as `\t`, `\n`, and `\\`, respectively.