From: David Kågedal <davidk@lysator.liu.se>
Date: Tue, 28 Jul 2009 08:32:18 +0000 (+0200)
Subject: Update the documentation of the raw diff output format
X-Git-Tag: v1.6.4~2
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=f552e51ef9d376c17fa707b7af9582108f4ec81c;p=git.git

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 1eeb1c768..b71712473 100644
--- 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
@@ -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.
 
+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:
 
diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt
index c52614156..4ef03578e 100644
--- 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
 
-Output format
--------------
+
 include::diff-format.txt[]
 
 
diff --git a/Documentation/git-diff-index.txt b/Documentation/git-diff-index.txt
index 26920d4f6..8b9ed2929 100644
--- 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.
 
-Output format
--------------
 include::diff-format.txt[]
 
 Operating Modes
diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
index 23b7abd3c..f2cef1260 100644
--- 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).
 
-Output format
--------------
+
 include::diff-format.txt[]
 
 
diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index a2f192fb7..0ac711230 100644
--- 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).
 
-Output format
--------------
+
 include::diff-format.txt[]
 
 EXAMPLES