Update the documentation of the raw diff output format
This includes mentioning the initial hash output of diff-tree, and changes the header to "raw output format" which is more descriptive. Signed-off-by: David Kågedal <davidk@lysator.liu.se> Signed-off-by: Junio C Hamano <gitster@pobox.com>
David Kågedal committed
Jul 28, 2009 at 10:32 UTC
f552e51ef9d376c17fa707b7af9582108f4ec81c
5 files changed
+10
-9
Documentation/diff-format.txt
+7
-1
@@ -1,4 +1,7 @@
1
-The output format from "git-diff-index", "git-diff-tree",
1
+Raw output format
2
+-----------------
3
+
4
+The raw output format from "git-diff-index", "git-diff-tree",
5
"git-diff-files" and "git diff --raw" are very similar.
6
7
These commands all compare two sets of things; what is
@@ -16,6 +19,9 @@ git-diff-tree [-r] <tree-ish-1> <tree-ish-2> [<pattern>...]::
19
git-diff-files [<pattern>...]::
20
compares the index and the files on the filesystem.
21
22
+The "git-diff-tree" command begins its ouput by printing the hash of
23
+what is being compared. After that, all the commands print one output
24
+line per changed file.
25
26
An output line is formatted this way:
27
Documentation/git-diff-files.txt
+1
-2
@@ -43,8 +43,7 @@ omit diff output for unmerged entries and just show "Unmerged".
43
-q::
44
Remain silent even on nonexistent files
45
46
-Output format
47
--------------
46
+
47
include::diff-format.txt[]
48
49
Documentation/git-diff-index.txt
-2
@@ -34,8 +34,6 @@ include::diff-options.txt[]
34
'git-diff-index' say that all non-checked-out files are up
35
to date.
36
37
-Output format
38
--------------
37
include::diff-format.txt[]
38
39
Operating Modes
Documentation/git-diff-tree.txt
+1
-2
@@ -159,8 +159,7 @@ HEAD commits it finds, which is even more interesting.
159
160
in case you care).
161
162
-Output format
163
--------------
162
+
163
include::diff-format.txt[]
164
165
Documentation/git-diff.txt
+1
-2
@@ -84,8 +84,7 @@ include::diff-options.txt[]
84
the diff to the named paths (you can give directory
85
names and get diff for all files under them).
86
87
-Output format
88
--------------
87
+
88
include::diff-format.txt[]
89
90
EXAMPLES