X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=Documentation%2Fdiff-format.txt;h=0398b408c05d2dccb9806c0add6d1acd13871d74;hb=50b4e0c178777a27164eb67676593255a9cbd035;hp=7e9a515ad74b16c3f82eba71a9503c6696c77503;hpb=81e50eabf06dd68e8e62a9b697eaf60904c58b22;p=git.git diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt index 7e9a515a..0398b408 100644 --- a/Documentation/diff-format.txt +++ b/Documentation/diff-format.txt @@ -1,61 +1,78 @@ -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 :: - compares the and the cache. +git-diff-index --cached :: + compares the and the index. git-diff-tree [-r] [...]:: compares the trees named by the two arguments. git-diff-files [...]:: - compares the cache and the files on the filesystem. + compares the index and the files on the filesystem. An output line is formatted this way: - ':' ' ' ' ' ' ' I I L - -By default, I and L are '\t' and '\n' respectively. When '-z' -flag is in effect, both I and L are '\0'. - -In each , and pair, left hand side describes -the left hand side of what is being compared ( in -git-diff-cache, in git-diff-tree, cache contents in -git-diff-files). Non-existence is shown by having 000000 in the - column. That is, 000000 appears as the first for -newly created files, and as the second for deleted files. - -Usually two are the same. When rename/copy detection is -used, however, an "create" and another "delete" records can be -merged into a single record that has two , old name and -new name. - - 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...... file.c file.c +------------------------------------------------ +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... A file4 +delete :100644 000000 1234567... 0000000... D file5 +unmerged :000000 000000 0000000... 0000000... U file6 +------------------------------------------------ + +That is, from the left to the right: + +. 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 index. + +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 @@ -64,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 HEAD 2. When the environment variable 'GIT_EXTERNAL_DIFF' is set, the @@ -79,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. @@ -87,8 +104,45 @@ where: The file parameters can point at the user's working file (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file` when a new file is added), or a temporary file (e.g. `old-file` in the -cache). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the +index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the 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 preceded 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.