Move --pretty options into Documentation/pretty-formats.txt
authorChris Riddoch <chris@syntacticsugar.org>
Tue, 21 Nov 2006 23:49:15 +0000 (16:49 -0700)
committerJunio C Hamano <junkio@cox.net>
Thu, 23 Nov 2006 00:06:32 +0000 (16:06 -0800)
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>
Documentation/git-diff-tree.txt
Documentation/git-log.txt
Documentation/git-rev-list.txt
Documentation/git-show.txt
Documentation/pretty-formats.txt [new file with mode: 0644]

index f7e8ff2..5d6e9dc 100644 (file)
@@ -73,10 +73,7 @@ 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
index c9ffff7..79643ac 100644 (file)
@@ -24,8 +24,8 @@ This manual page describes only the most frequently used options.
 
 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.
index 00a95e2..ec43c0b 100644 (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],
 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::
 
index 2b4df3f..4c880a8 100644 (file)
@@ -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 (file)
index 0000000..996f628
--- /dev/null
@@ -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.