{"thread":{"id":"43683","subject":"[PATCH] Move --pretty options into Documentation/pretty-formats.txt","startedAt":"2006-11-21T23:49:15Z","lastAt":"2006-11-21T23:49:15Z","messageCount":1,"participants":["Chris Riddoch"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"296643","messageId":"11641529553903-git-send-email-chris@syntacticsugar.org","threadId":"43683","inReplyTo":null,"subject":"[PATCH] Move --pretty options into Documentation/pretty-formats.txt","fromName":"Chris Riddoch","fromEmail":"chris@syntacticsugar.org","sentAt":"2006-11-21T23:49:15Z","receivedAt":"2006-11-21T23:49:15Z","isPatch":true,"sender":{"key":"chris@syntacticsugar.org","avatar":null},"body":"Asciidoc-include it into the manuals for programs that use the\n--pretty command-line option, for consistency among the docs.\n\nThis describes all the pretty-formats currently listed in the cmit_fmt\nenum in commit.h, and also briefly describes the presence and format\nof the 'Merge: ' line in some pretty formats.\n\nThere's a hedge that limiting your view of history can affect what\ngoes in the Merge: line, and that --abbrev/--no-abbrev do nothing to\nthe 'raw' format.\n\nSigned-off-by: Chris Riddoch <chris@syntacticsugar.org>\n---\n Documentation/git-diff-tree.txt  |    5 +--\n Documentation/git-log.txt        |    4 +-\n Documentation/git-rev-list.txt   |    6 +---\n Documentation/git-show.txt       |    5 +--\n Documentation/pretty-formats.txt |   60 ++++++++++++++++++++++++++++++++++++++\n 5 files changed, 65 insertions(+), 15 deletions(-)\n\ndiff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt\nindex f7e8ff2..5d6e9dc 100644\n--- a/Documentation/git-diff-tree.txt\n+++ b/Documentation/git-diff-tree.txt\n@@ -73,10 +73,7 @@ separated with a single space are given.\n \tThis flag causes \"git-diff-tree --stdin\" to also show\n \tthe commit message before the differences.\n \n---pretty[=(raw|medium|short)]::\n-\tThis is used to control \"pretty printing\" format of the\n-\tcommit message.  Without \"=<style>\", it defaults to\n-\tmedium.\n+include::pretty-formats.txt[]\n \n --no-commit-id::\n \tgit-diff-tree outputs a line with the commit ID when\ndiff --git a/Documentation/git-log.txt b/Documentation/git-log.txt\nindex c9ffff7..79643ac 100644\n--- a/Documentation/git-log.txt\n+++ b/Documentation/git-log.txt\n@@ -24,8 +24,8 @@ This manual page describes only the most\n \n OPTIONS\n -------\n---pretty=<format>::\n-\tControls the way the commit log is formatted.\n+\n+include::pretty-formats.txt[]\n \n --max-count=<n>::\n \tLimits the number of commits to show.\ndiff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt\nindex 00a95e2..ec43c0b 100644\n--- a/Documentation/git-rev-list.txt\n+++ b/Documentation/git-rev-list.txt\n@@ -79,11 +79,7 @@ Using these options, gitlink:git-rev-lis\n more specialized family of commit log tools: gitlink:git-log[1],\n gitlink:git-show[1], and gitlink:git-whatchanged[1]\n \n---pretty[='<format>']::\n-\n-\tPretty print the contents of the commit logs in a given format,\n-\twhere '<format>' can be one of 'raw', 'medium', 'short', 'full',\n-\tand 'oneline'. When left out the format default to 'medium'.\n+include::pretty-formats.txt[]\n \n --relative-date::\n \ndiff --git a/Documentation/git-show.txt b/Documentation/git-show.txt\nindex 2b4df3f..4c880a8 100644\n--- a/Documentation/git-show.txt\n+++ b/Documentation/git-show.txt\n@@ -26,10 +26,7 @@ OPTIONS\n <commitid>::\n \tID of the commit to show.\n \n---pretty=<format>::\n-\tControls the output format for the commit logs.\n-\t<format> can be one of 'raw', 'medium', 'short', 'full',\n-\tand 'oneline'.\n+include::pretty-formats.txt[]\n \n Author\n ------\ndiff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt\nnew file mode 100644\nindex 0000000..4496c87\n--- /dev/null\n+++ b/Documentation/pretty-formats.txt\n@@ -0,0 +1,60 @@\n+--pretty[='<format>']::\n+\n+        Pretty-prints the details of a commit.  The default format is\n+        'medium'.  If the commit is a merge, and if the pretty-format\n+        is not 'oneline', 'email' or 'raw', an additional line is\n+        inserted before the 'Author:' line.  This line begins with\n+        \"Merge: \" and the sha1s of ancestral commits are printed,\n+        separated by spaces.  Note that the listed commits may not\n+        necessarily be the list of the *direct* parent commits if you\n+        have limited your view of history: for example, if you are\n+        only interested in changes related to a certain directory or\n+        file.\n+\n+        * 'oneline'\n+\n+            <sha1> <title line>\n+\n+        * 'short'\n+\n+            commit <sha1>\n+            Author: <author>\n+            <title line>\n+\n+        * 'medium'\n+\n+            commit <sha1>\n+            Author: <author>\n+            Date: <date>\n+            <full commit message>\n+\n+        * 'full'\n+\n+            commit <sha1>\n+            Author: <author>\n+            Commit: <committer>\n+            <full commit message>\n+\n+        * 'fuller'\n+\n+           commit <sha1>\n+           Author: <author>\n+           AuthorDate: <date & time>\n+           Commit: <committer>\n+           CommitDate: <date & time>\n+           <full commit message>\n+\n+        * 'email'\n+\n+           from <sha1> <date>\n+           From: <author>\n+           Date: <date & time>\n+           Subject: [PATCH] <title line>\n+\n+          <full commit message>\n+\n+        * 'raw'\n+\n+           The entire commit exactly as stored in the commit object\n+           The SHA1s are displayed in full, regardless of whether\n+           --abbrev or --no-abbrev are used.\n-- \n1.4.4\n"}]}