doc: git-diff: apply format changes to diff-format

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Jean-Noël Avila 2024-11-18 22:05:51 +00:00 committed by Junio C Hamano
parent 6b552e39c0
commit 6ace09b2f9
1 changed files with 21 additions and 21 deletions

View File

@ -1,25 +1,25 @@
Raw output format Raw output format
----------------- -----------------


The raw output format from "git-diff-index", "git-diff-tree", The raw output format from `git-diff-index`, `git-diff-tree`,
"git-diff-files" and "git diff --raw" are very similar. `git-diff-files` and `git diff --raw` are very similar.


These commands all compare two sets of things; what is These commands all compare two sets of things; what is
compared differs: compared differs:


git-diff-index <tree-ish>:: `git-diff-index <tree-ish>`::
compares the <tree-ish> and the files on the filesystem. compares the _<tree-ish>_ and the files on the filesystem.


git-diff-index --cached <tree-ish>:: `git-diff-index --cached <tree-ish>`::
compares the <tree-ish> and the index. compares the _<tree-ish>_ and the index.


git-diff-tree [-r] <tree-ish-1> <tree-ish-2> [<pattern>...]:: `git-diff-tree [-r] <tree-ish-1> <tree-ish-2> [<pattern>...]`::
compares the trees named by the two arguments. compares the trees named by the two arguments.


git-diff-files [<pattern>...]:: `git-diff-files [<pattern>...]`::
compares the index and the files on the filesystem. compares the index and the files on the filesystem.


The "git-diff-tree" command begins its output by printing the hash of The `git-diff-tree` command begins its output by printing the hash of
what is being compared. After that, all the commands print one output what is being compared. After that, all the commands print one output
line per changed file. line per changed file.


@ -54,19 +54,19 @@ That is, from the left to the right:


Possible status letters are: Possible status letters are:


- A: addition of a file - `A`: addition of a file
- C: copy of a file into a new one - `C`: copy of a file into a new one
- D: deletion of a file - `D`: deletion of a file
- M: modification of the contents or mode of a file - `M`: modification of the contents or mode of a file
- R: renaming of a file - `R`: renaming of a file
- T: change in the type of the file (regular file, symbolic link or submodule) - `T`: change in the type of the file (regular file, symbolic link or submodule)
- U: file is unmerged (you must complete the merge before it can - `U`: file is unmerged (you must complete the merge before it can
be committed) be committed)
- X: "unknown" change type (most probably a bug, please report it) - `X`: "unknown" change type (most probably a bug, please report it)


Status letters C and R are always followed by a score (denoting the Status letters `C` and `R` are always followed by a score (denoting the
percentage of similarity between the source and target of the move or percentage of similarity between the source and target of the move or
copy). Status letter M may be followed by a score (denoting the copy). Status letter `M` may be followed by a score (denoting the
percentage of dissimilarity) for file rewrites. percentage of dissimilarity) for file rewrites.


The sha1 for "dst" is shown as all 0's if a file on the filesystem The sha1 for "dst" is shown as all 0's if a file on the filesystem
@ -86,7 +86,7 @@ verbatim and the line is terminated by a NUL byte.
diff format for merges diff format for merges
---------------------- ----------------------


"git-diff-tree", "git-diff-files" and "git-diff --raw" `git-diff-tree`, `git-diff-files` and `git-diff --raw`
can take `-c` or `--cc` option can take `-c` or `--cc` option
to generate diff output also for merge commits. The output differs to generate diff output also for merge commits. The output differs
from the format described above in the following way: from the format described above in the following way:
@ -128,7 +128,7 @@ other diff formats
------------------ ------------------


The `--summary` option describes newly added, deleted, renamed and The `--summary` option describes newly added, deleted, renamed and
copied files. The `--stat` option adds diffstat(1) graph to the copied files. The `--stat` option adds `diffstat`(1) graph to the
output. These options can be combined with other options, such as output. These options can be combined with other options, such as
`-p`, and are meant for human consumption. `-p`, and are meant for human consumption.