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. Signed-off-by: Chris Riddoch <chris@xxxxxxxxxxxxxxxxxx> --- 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 | 56 ++++++++++++++++++++++++++++++++++++++ 5 files changed, 62 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 format, - where '<format>' can be one of 'raw', 'medium', 'short', 'full', - and 'oneline'. When left out the format default to 'medium'. +include::pretty-formats.txt[] --relative-date:: diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt index 2b4df3f..4c880a8 100644 --- a/Documentation/git-show.txt +++ b/Documentation/git-show.txt @@ -26,10 +26,7 @@ OPTIONS <commitid>:: ID of the commit to show. ---pretty=<format>:: - Controls the output format for the commit logs. - <format> can be one of 'raw', 'medium', 'short', 'full', - and 'oneline'. +include::pretty-formats.txt[] Author ------ diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt new file mode 100644 index 0000000..293ea0f --- /dev/null +++ b/Documentation/pretty-formats.txt @@ -0,0 +1,56 @@ +--pretty[='<format>']:: + + Pretty-prints the details of a commit. The default format is + 'medium'. If the commit is a merge, and 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 each parent commit are printed, + separated by spaces. These sha1's are abbreviated to 8 + characters; use the --abbrev or --no-abbrev options to alter + this behavior. + + * 'oneline' + + <sha1> <title line> + + * 'short' + + commit <sha1> + Author: <author> + <title line> + + * 'medium' + + commit <sha1> + Author: <author> + Date: <date> + <full commit message> + + * 'full' + + commit <sha1> + Author: <author> + Commit: <committer> + <full commit message> + + * 'fuller' + + commit <sha1> + Author: <author> + AuthorDate: <date & time> + Commit: <committer> + CommitDate: <date & time> + <full commit message> + + * 'email' + + from <sha1> <date> + From: <author> + Date: <date & time> + Subject: [PATCH] <title line> + + <full commit message> + + * 'raw' + + The entire commit exactly as stored in the commit object -- 1.4.4 - 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