Move --pretty options into Documentation/pretty-formats.txt

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

This describes all the pretty-formats currently listed in the cmit_fmt
enum in commit.h, and also briefly describes the presence and format
of the 'Merge: ' line in some pretty formats.

There's a hedge that limiting your view of history can affect what
goes in the Merge: line, and that --abbrev/--no-abbrev do nothing to
the 'raw' format.

Signed-off-by: Chris Riddoch <chris@syntacticsugar.org>
Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
Chris Riddoch 2006-11-21 16:49:15 -07:00 committed by Junio C Hamano
parent 5942706357
commit 5d1faf8791
5 changed files with 83 additions and 15 deletions

View File

@ -73,10 +73,7 @@ separated with a single space are given.
This flag causes "git-diff-tree --stdin" to also show This flag causes "git-diff-tree --stdin" to also show
the commit message before the differences. the commit message before the differences.
--pretty[=(raw|medium|short)]:: include::pretty-formats.txt[]
This is used to control "pretty printing" format of the
commit message. Without "=<style>", it defaults to
medium.
--no-commit-id:: --no-commit-id::
git-diff-tree outputs a line with the commit ID when git-diff-tree outputs a line with the commit ID when

View File

@ -24,8 +24,8 @@ This manual page describes only the most frequently used options.
OPTIONS OPTIONS
------- -------
--pretty=<format>::
Controls the way the commit log is formatted. include::pretty-formats.txt[]
--max-count=<n>:: --max-count=<n>::
Limits the number of commits to show. Limits the number of commits to show.

View File

@ -79,11 +79,7 @@ Using these options, gitlink:git-rev-list[1] will act similar to the
more specialized family of commit log tools: gitlink:git-log[1], more specialized family of commit log tools: gitlink:git-log[1],
gitlink:git-show[1], and gitlink:git-whatchanged[1] gitlink:git-show[1], and gitlink:git-whatchanged[1]
--pretty[='<format>']:: include::pretty-formats.txt[]
Pretty print the contents of the commit logs in a given format,
where '<format>' can be one of 'raw', 'medium', 'short', 'full',
and 'oneline'. When left out the format default to 'medium'.
--relative-date:: --relative-date::

View File

@ -26,10 +26,7 @@ OPTIONS
<commitid>:: <commitid>::
ID of the commit to show. ID of the commit to show.
--pretty=<format>:: include::pretty-formats.txt[]
Controls the output format for the commit logs.
<format> can be one of 'raw', 'medium', 'short', 'full',
and 'oneline'.
Author Author
------ ------

View File

@ -0,0 +1,78 @@
--pretty[='<format>']::
Pretty-prints the details of a commit. `--pretty`
without an explicit `=<format>` defaults to 'medium'.
If the commit is a merge, and if the pretty-format
is not 'oneline', 'email' or 'raw', an additional line is
inserted before the 'Author:' line. This line begins with
"Merge: " and the sha1s of ancestral commits are printed,
separated by spaces. Note that the listed commits may not
necessarily be the list of the *direct* parent commits if you
have limited your view of history: for example, if you are
only interested in changes related to a certain directory or
file. Here are some additional details for each format:
* 'oneline'
<sha1> <title line>
+
This is designed to be as compact as possible.
* 'short'
commit <sha1>
Author: <author>
<title line>
* 'medium'
commit <sha1>
Author: <author>
Date: <date>
<title line>
<full commit message>
* 'full'
commit <sha1>
Author: <author>
Commit: <committer>
<title line>
<full commit message>
* 'fuller'
commit <sha1>
Author: <author>
AuthorDate: <date & time>
Commit: <committer>
CommitDate: <date & time>
<title line>
<full commit message>
* 'email'
From <sha1> <date>
From: <author>
Date: <date & time>
Subject: [PATCH] <title line>
full commit message>
* 'raw'
+
The 'raw' format shows the entire commit exactly as
stored in the commit object. Notably, the SHA1s are
displayed in full, regardless of whether --abbrev or
--no-abbrev are used, and 'parents' information show the
true parent commits, without taking grafts nor history
simplification into account.