X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fdiff-format.txt;h=97756ec03086614051d5780b00825e24ee5ef56f;hb=ee34518d629331dadd58b1a75294369d679eda8b;hp=dacd8fb53488fadd7ebb6c1964e60a60072eae80;hpb=d67c4af41f7975940e8fec6405411581570eb672;p=git.git diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt index dacd8fb5..97756ec0 100644 --- a/Documentation/diff-format.txt +++ b/Documentation/diff-format.txt @@ -8,13 +8,13 @@ git-diff-index :: compares the and the files on the filesystem. git-diff-index --cached :: - compares the and the cache. + 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: @@ -47,7 +47,7 @@ That is, from the left to the right: . 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. +and it is out of sync with the index. Example: @@ -55,6 +55,11 @@ 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 -------------------------- @@ -76,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-index -p $(cat .git/HEAD) + GIT_DIFF_OPTS=-c git-diff-index -p HEAD 2. When the environment variable 'GIT_EXTERNAL_DIFF' is set, the @@ -99,14 +104,14 @@ 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 +git specific extension to diff format ------------------------------------- What -p option produces is slightly different from the @@ -137,3 +142,7 @@ the file that rename/copy produces, respectively. rename to similarity index dissimilarity index + index .. + +3. TAB, LF, and backslash characters in pathnames are + represented as `\t`, `\n`, and `\\`, respectively.