From: Jakub Narebski <jnareb@gmail.com>
To: git@vger.kernel.org
Subject: [PATCH] Documentation: More on --pretty with git-diff-tree
Date: Sun, 27 Apr 2008 19:40:42 +0200 [thread overview]
Message-ID: <200804271940.44940.jnareb@gmail.com> (raw)
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@gmail.com>
---
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
next reply other threads:[~2008-04-27 17:41 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-04-27 17:40 Jakub Narebski [this message]
2008-04-27 21:16 ` [PATCH] Documentation: More on --pretty with git-diff-tree Junio C Hamano
2008-04-27 22:18 ` Jakub Narebski
2008-04-28 1:39 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=200804271940.44940.jnareb@gmail.com \
--to=jnareb@gmail.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).