[PATCH] Move --pretty options into Documentation/pretty-formats.txt

Previous thread: New software uploaded by Gary on Nov 18 03:20:00 MSK 2006 by Star Allen on Friday, November 17, 2006 - 8:41 pm. (1 message)

Next thread: New software uploaded by Victor on Nov 18 05:00:00 MSK 2006 by Bobbi Jones on Friday, November 17, 2006 - 10:16 pm. (1 message)
To: <git@...>
Cc: Chris Riddoch <chris@...>
Date: Friday, November 17, 2006 - 8:58 pm

Asciidoc-include it into the manuals for programs that use the
--pretty command-line option, for consistency among the docs.

Signed-off-by: Chris Riddoch <chris@syntacticsugar.org>
---
Documentation/git-diff-tree.txt | 7 +++----
Documentation/git-log.txt | 3 +--
Documentation/git-rev-list.txt | 6 +-----
Documentation/git-show.txt | 5 +----
Documentation/pretty-formats.txt | 29 +++++++++++++++++++++++++++++
5 files changed, 35 insertions(+), 15 deletions(-)

diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
index f7e8ff2..add0d2f 100644
--- a/Documentation/git-diff-tree.txt
+++ b/Documentation/git-diff-tree.txt
@@ -73,10 +73,9 @@ separated with a single space are given.
This flag causes "git-diff-tree --stdin" to also show
the commit message before the differences.

---pretty[=(raw|medium|short)]::
- This is used to control "pretty printing" format of the
- commit message. Without "=<style>", it defaults to
- medium.
+
+include::pretty-formats.txt[]
+

--no-commit-id::
git-diff-tree outputs a line with the commit ID when
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index c9ffff7..3f50b70 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -24,8 +24,7 @@ This manual page describes only the most

OPTIONS
-------
---pretty=<format>::
- Controls the way the commit log is formatted.
+include::pretty-formats.txt[]

--max-count=<n>::
Limits the number of commits to show.
diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt
index 00a95e2..ec43c0b 100644
--- a/Documentation/git-rev-list.txt
+++ b/Documentation/git-rev-list.txt
@@ -79,11 +79,7 @@ Using these options, gitlink:git-rev-lis
more specialized family of commit log tools: gitlink:git-log[1],
gitlink:git-show[1], and gitlink:git-whatchanged[1]

---pretty[='<format>']::
-
- Pretty print the contents of the commit logs in a given form...

To: Chris Riddoch <chris@...>
Cc: <git@...>
Date: Friday, November 17, 2006 - 9:15 pm

Beautiful, although I doubt we would want to spell out the exact
output format in that documentation (if so you would need to
talk about Merge: entries that we conditionally give and how
commit object names are abbreviated and such). On the other
hand, we might want to talk about Merge: entries anyway to say
the values can be affected by merge simplification.

Independent of the above concerns, I trust somebody else will
follow this up with a patch to describe missing pretty formats?

-

Previous thread: New software uploaded by Gary on Nov 18 03:20:00 MSK 2006 by Star Allen on Friday, November 17, 2006 - 8:41 pm. (1 message)

Next thread: New software uploaded by Victor on Nov 18 05:00:00 MSK 2006 by Bobbi Jones on Friday, November 17, 2006 - 10:16 pm. (1 message)