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>

diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt
index 1eeb1c76838c1911fc4d57b36a16dece0538809a..b71712473ed13020bca3f133ea4a28c5081b7f9e 100644 (file)
--- a/Documentation/diff-format.txt
+++ b/Documentation/diff-format.txt
@@ -1,4 +1,7 @@
-The output format from "git-diff-index", "git-diff-tree",
+Raw output format
+-----------------
+
+The raw output format from "git-diff-index", "git-diff-tree",

 "git-diff-files" and "git diff --raw" are very similar.
 
 These commands all compare two sets of things; what is
 "git-diff-files" and "git diff --raw" are very similar.
 
 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>...]::
 git-diff-files [<pattern>...]::
         compares the index and the files on the filesystem.
 
 git-diff-files [<pattern>...]::
         compares the index and the files on the filesystem.
 

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

 
 An output line is formatted this way:
 
 
 An output line is formatted this way:
 

diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt
index c5261415643d359648900e17f522ba7b96fed44a..4ef03578ebc58f3b678e8805644ae8c0ad4b998b 100644 (file)
--- a/Documentation/git-diff-files.txt
+++ b/Documentation/git-diff-files.txt
@@ -43,8 +43,7 @@ omit diff output for unmerged entries and just show "Unmerged".
 -q::
        Remain silent even on nonexistent files
 
 -q::
        Remain silent even on nonexistent files
 

-Output format
--------------
+

 include::diff-format.txt[]
 
 
 include::diff-format.txt[]
 
 

diff --git a/Documentation/git-diff-index.txt b/Documentation/git-diff-index.txt
index 26920d4f63cd213ff17ab28d8dd0dbea94482147..8b9ed2929980ec9928930496375df5e9d72e4b51 100644 (file)
--- a/Documentation/git-diff-index.txt
+++ b/Documentation/git-diff-index.txt
@@ -34,8 +34,6 @@ include::diff-options.txt[]
        'git-diff-index' say that all non-checked-out files are up
        to date.
 
        'git-diff-index' say that all non-checked-out files are up
        to date.
 

-Output format
--------------

 include::diff-format.txt[]
 
 Operating Modes
 include::diff-format.txt[]
 
 Operating Modes

diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
index 23b7abd3c6b0e02eb325983eaad66598c42fc8be..f2cef1260b7f74254b96ce65f8aa55267b618c29 100644 (file)
--- a/Documentation/git-diff-tree.txt
+++ b/Documentation/git-diff-tree.txt
@@ -159,8 +159,7 @@ HEAD commits it finds, which is even more interesting.
 
 in case you care).
 
 
 in case you care).
 

-Output format
--------------
+

 include::diff-format.txt[]
 
 
 include::diff-format.txt[]
 
 

diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index a2f192fb7519117f8e47f3ec4608e3301c200dc3..0ac711230e24bf7238b2e3a215cdc3c4ce0d2087 100644 (file)
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -84,8 +84,7 @@ include::diff-options.txt[]
        the diff to the named paths (you can give directory
        names and get diff for all files under them).
 
        the diff to the named paths (you can give directory
        names and get diff for all files under them).
 

-Output format
--------------
+

 include::diff-format.txt[]
 
 EXAMPLES
 include::diff-format.txt[]
 
 EXAMPLES