Documentation: customize diff-options depending on particular command

Customize diff-options depending on particular command as follows,
mostly to make git-diff and git-format-patch manuals less confusing:

* git-format-patch:

- Mark --patch-with-stat as being the default.

- Change -p description so that it matches what it actually does and
so that it doesn't refer to absent "section on generating
patches".

* git-diff: mark -p as being the default.

* git-diff-index/git-diff-files/git-diff-tree: mark --raw as being
the default.

Signed-off-by: Sergei Organov <osv@javad.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index b1f528ae8864e429a509365a79d16bb8341620e1..e4af393515c346528bccb7a4f2d3823aebddddfc 100644 (file)
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -1,5 +1,25 @@
+// Please don't remove this comment as asciidoc behaves badly when
+// the first non-empty line is ifdef/ifndef. The symptom is that
+// without this comment the <git-diff-core> attribute conditionally
+// defined below ends up being defined unconditionally.
+// Last checked with asciidoc 7.0.2.
+
+ifndef::git-format-patch[]
+ifndef::git-diff[]
+:git-diff-core: 1
+endif::git-diff[]
+endif::git-format-patch[]
+
+ifdef::git-format-patch[]

 -p::
 -p::

-       Generate patch (see section on generating patches)
+       Generate patches without diffstat.
+endif::git-format-patch[]
+
+ifndef::git-format-patch[]
+-p::
+       Generate patch (see section on generating patches).
+       {git-diff? This is the default.}
+endif::git-format-patch[]

 
 -u::
        Synonym for "-p".
 
 -u::
        Synonym for "-p".


@@ -13,6 +33,7 @@
 
 --raw::
        Generate the raw format.
 
 --raw::
        Generate the raw format.

+       {git-diff-core? This is the default.}

 
 --patch-with-raw::
        Synonym for "-p --raw".
 
 --patch-with-raw::
        Synonym for "-p --raw".


@@ -41,6 +62,7 @@
 
 --patch-with-stat::
        Synonym for "-p --stat".
 
 --patch-with-stat::
        Synonym for "-p --stat".

+       {git-format-patch? This is the default.}

 
 -z::
        NUL-line termination on output.  This affects the --raw
 
 -z::
        NUL-line termination on output.  This affects the --raw

diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index 11c4216c4a5c705c6af55b1367cae96b13c20251..2808a5ec44d8a9e911faf4c7d24eb844d69390f2 100644 (file)
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -75,6 +75,7 @@ and the range notations ("<commit>..<commit>" and
 
 OPTIONS
 -------
 
 OPTIONS
 -------

+:git-diff: 1

 include::diff-options.txt[]
 
 <path>...::
 include::diff-options.txt[]
 
 <path>...::

diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 9d4bae2f600ba637a978648fe81cac5d6cbc903b..6fb94298516620e6991e82272a7e657a8296f7ca 100644 (file)
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -66,6 +66,7 @@ reference.
 
 OPTIONS
 -------
 
 OPTIONS
 -------

+:git-format-patch: 1

 include::diff-options.txt[]
 
 -<n>::
 include::diff-options.txt[]
 
 -<n>::