git-diff.txt: add section "output format" describing the diff formats

git-diff.txt includes diff-options.txt which for the -p option refers
to a section "generating patches.." which is missing from the git-diff
documentation.  This patch adapts diff-format.txt to additionally
mention the git-diff program, and includes diff-format.txt into
git-diff.txt.

Tino Keitel noticed this problem.

Signed-off-by: Gerrit Pape <pape@smarden.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt
index 001503205b24d5c20ec10792c4ab6c4c7221bcb7..9709c35c98bc678d1f2e339c8e2d4bbcd7e6231f 100644 (file)
--- a/Documentation/diff-format.txt
+++ b/Documentation/diff-format.txt
@@ -1,5 +1,5 @@
-The output format from "git-diff-index", "git-diff-tree" and
-"git-diff-files" are very similar.
+The 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
 compared differs:
 
 These commands all compare two sets of things; what is
 compared differs:


@@ -62,7 +62,8 @@ respectively.
 diff format for merges
 ----------------------
 
 diff format for merges
 ----------------------
 

-"git-diff-tree" and "git-diff-files" can take '-c' or '--cc' option
+"git-diff-tree", "git-diff-files" and "git-diff --raw"
+can take '-c' or '--cc' option

 to generate diff output also for merge commits.  The output differs
 from the format described above in the following way:
 
 to generate diff output also for merge commits.  The output differs
 from the format described above in the following way:
 


@@ -86,10 +87,10 @@ Generating patches with -p
 --------------------------
 
 When "git-diff-index", "git-diff-tree", or "git-diff-files" are run
 --------------------------
 
 When "git-diff-index", "git-diff-tree", or "git-diff-files" are run

-with a '-p' option, they do not produce the output described above;
-instead they produce a patch file.  You can customize the creation
-of such patches via the GIT_EXTERNAL_DIFF and the GIT_DIFF_OPTS
-environment variables.
+with a '-p' option, or "git diff" without the '--raw' option, they
+do not produce the output described above; instead they produce a
+patch file.  You can customize the creation of such patches via the
+GIT_EXTERNAL_DIFF and the GIT_DIFF_OPTS environment variables.

 
 What the -p option produces is slightly different from the traditional
 diff format.
 
 What the -p option produces is slightly different from the traditional
 diff format.


@@ -137,8 +138,8 @@ file made it into the new one.
 combined diff format
 --------------------
 
 combined diff format
 --------------------
 

-git-diff-tree and git-diff-files can take '-c' or '--cc' option
-to produce 'combined diff', which looks like this:
+"git-diff-tree", "git-diff-files" and "git-diff" can take '-c' or
+'--cc' option to produce 'combined diff', which looks like this:

 
 ------------
 diff --combined describe.c
 
 ------------
 diff --combined describe.c

diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index db2eb46a191ecafac09492b95ec6f3a3233dbc6e..201d5daf1a98e510bbf838ab2a66c07bae88f991 100644 (file)
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -82,6 +82,9 @@ 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
 --------
 
 EXAMPLES
 --------