[PATCH] Documentation: More on --pretty with git-diff-tree

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Mention that --pretty=<format> option is used by git-diff-tree only
if both --stdin and -v options are provided.  Because of that it doesn't
make sense to list pretty formats in git-diff-tree(1); linking to
git-show(1) should be enough.

Above changes appear only in git-diff-tree(1) manpage.

Signed-off-by: Jakub Narebski <jnareb@xxxxxxxxx>
---
I have stumbled upon this when trying to simplify generating
'commitdiff_plain' view in gitweb.

"make doc" compiles without errors, and produces expected result.

 Documentation/git-diff-tree.txt  |    6 +++++-
 Documentation/pretty-options.txt |    3 +++
 2 files changed, 8 insertions(+), 1 deletions(-)

diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
index 58d02c6..afe82e3 100644
--- a/Documentation/git-diff-tree.txt
+++ b/Documentation/git-diff-tree.txt
@@ -24,6 +24,7 @@ Note that "git-diff-tree" can use the tree encapsulated in a commit object.
 
 OPTIONS
 -------
+:git-diff-tree: 1
 include::diff-options.txt[]
 
 <tree-ish>::
@@ -104,7 +105,10 @@ include::pretty-options.txt[]
 	if the diff itself is empty.
 
 
-include::pretty-formats.txt[]
+Pretty Formats
+--------------
+
+For description of pretty formats see for example linkgit:git-show[1]
 
 
 Limiting Output
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index 6d66c74..8c101b9 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -3,6 +3,9 @@
 	Pretty-print the contents of the commit logs in a given format,
 	where '<format>' can be one of 'oneline', 'short', 'medium',
 	'full', 'fuller', 'email', 'raw' and 'format:<string>'.
+ifdef::git-diff-tree[]
+	This option is used for "git-diff-tree --stdin -v" combination.
+endif::git-diff-tree[]
 	When omitted, the format defaults to 'medium'.
 +
 Note: you can specify the default pretty format in the repository
-- 
1.5.5

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux