Autogenerated HTML docs for v1.5.2-rc3-39-gaf9b
authorJunio C Hamano <junio@hera.kernel.org>
Tue, 15 May 2007 03:13:17 +0000 (03:13 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Tue, 15 May 2007 03:13:17 +0000 (03:13 +0000)
22 files changed:
RelNotes-1.5.1.5.txt [new file with mode: 0644]
RelNotes-1.5.2.txt
git-add.html
git-add.txt
git-am.html
git-am.txt
git-applymbox.html
git-applymbox.txt
git-diff-tree.html
git-diff-tree.txt
git-log.html
git-log.txt
git-mailinfo.html
git-mailinfo.txt
git-rev-list.html
git-rev-list.txt
git-show.html
git-show.txt
gitattributes.html
gitattributes.txt
pretty-formats.txt
pretty-options.txt [new file with mode: 0644]

diff --git a/RelNotes-1.5.1.5.txt b/RelNotes-1.5.1.5.txt
new file mode 100644 (file)
index 0000000..5cfe0b5
--- /dev/null
@@ -0,0 +1,37 @@
+GIT v1.5.1.5 Release Notes (draft)
+==========================
+
+Fixes since v1.5.1.4
+--------------------
+
+* Bugfixes
+
+  - git-svn was reported to segfault for many people on list and
+    #git; hopefully this has been fixed.
+
+  - "git-svn clone" does not try to minimize the URL
+    (i.e. connect to higher level hierarchy) by default, as this
+    can prevent clone to fail if only part of the repository
+    (e.g. 'trunk') is open to public.
+
+  - "git checkout branch^0" did not detach the head when you are
+    already on 'branch'; backported the fix from the 'master'.
+
+  - "git-config section.var" did not correctly work when
+    existing configuration file had both [section] and [section "name"]
+    next to each other.
+
+  - "git clone ../other-directory" was fooled if the current
+    directory $PWD points at is a symbolic link.
+
+  - (build) tree_entry_extract() function was both static inline
+    and extern, which caused trouble compiling with Forte12
+    compilers on Sun.
+
+  - Many documentation fixes.
+
+--
+exec >/var/tmp/1
+O=v1.5.1.4-26-gb4b20b2
+echo O=`git describe refs/heads/maint`
+git shortlog --no-merges $O..refs/heads/maint
index d1c2cac4fcacf09104a8b239b1598a77c443f81b..7dbdb26988b9832fed04ebce9dfbd0bdf091d5dc 100644 (file)
@@ -26,7 +26,7 @@ Updates since v1.5.1
   considered a binary or text (the former would be treated by
   'git diff' not to produce textual output; the latter can go
   through the line endings conversion process in repositories
-  with core.autocrlf set), expand and unexpand '$ident$' keyword
+  with core.autocrlf set), expand and unexpand '$Id$' keyword
   with blob object name, specify a custom 3-way merge driver,
   and specify a custom diff driver.  You can also apply
   arbitrary filter to contents on check-in/check-out codepath
index 48114b6bbe0da031ebc4a71c076058862846ba74..03df0ed7283417cca918ef55960ce40908f09b79 100644 (file)
@@ -347,8 +347,11 @@ commit.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        Update all files that git already knows about. This is what\r
-        "git commit -a" does in preparation for making a commit.\r
+        Update only files that git already knows about. This is similar\r
+        to what "git commit -a" does in preparation for making a commit,\r
+        except that the update is limited to paths specified on the\r
+        command line. If no paths are specified, all tracked files are\r
+        updated.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -545,7 +548,7 @@ diff
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 08-May-2007 00:32:26 UTC\r
+Last updated 15-May-2007 03:12:35 UTC\r
 </div>\r
 </div>\r
 </body>\r
index ea2701846f3b9f2ddd86942223df65872a70b64f..27b9c0f8cc1ff8f7c42c0fdcd86008c7f8d2a5be 100644 (file)
@@ -57,8 +57,11 @@ OPTIONS
        the index.
 
 -u::
-       Update all files that git already knows about. This is what
-       "git commit -a" does in preparation for making a commit.
+       Update only files that git already knows about. This is similar
+       to what "git commit -a" does in preparation for making a commit,
+       except that the update is limited to paths specified on the
+       command line. If no paths are specified, all tracked files are
+       updated.
 
 \--::
        This option can be used to separate command-line options from
index f2a433f8263994489d8309508c1d364645aaa34d..9984b77285aa6311c9f055ae2f251c25ae476554 100644 (file)
@@ -273,8 +273,9 @@ git-am(1) Manual Page
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
 <div class="verseblock">\r
-<div class="content"><em>git-am</em> [--signoff] [--dotest=&lt;dir&gt;] [--utf8 | --no-utf8] [--binary] [--3way]\r
-         [--interactive] [--whitespace=&lt;option&gt;] [-C&lt;n&gt;] [-p&lt;n&gt;]\r
+<div class="content"><em>git-am</em> [--signoff] [--dotest=&lt;dir&gt;] [--keep] [--utf8 | --no-utf8]\r
+         [--3way] [--interactive] [--binary]\r
+         [--whitespace=&lt;option&gt;] [-C&lt;n&gt;] [-p&lt;n&gt;]\r
          &lt;mbox&gt;&#8230;\r
 <em>git-am</em> [--skip | --resolved]</div></div>\r
 </div>\r
@@ -329,7 +330,7 @@ current branch.</p>
 <p>\r
         Pass <tt>-u</tt> flag to <tt>git-mailinfo</tt> (see <a href="git-mailinfo.html">git-mailinfo(1)</a>).\r
         The proposed commit log message taken from the e-mail\r
-        are re-coded into UTF-8 encoding (configuration variable\r
+        is re-coded into UTF-8 encoding (configuration variable\r
         <tt>i18n.commitencoding</tt> can be used to specify project's\r
         preferred encoding if it is not UTF-8).\r
 </p>\r
@@ -346,15 +347,6 @@ default.   You could use <tt>--no-utf8</tt> to override this.</p>
 </p>\r
 </dd>\r
 <dt>\r
--b, --binary\r
-</dt>\r
-<dd>\r
-<p>\r
-        Pass <tt>--allow-binary-replacement</tt> flag to <tt>git-apply</tt>\r
-        (see <a href="git-apply.html">git-apply(1)</a>).\r
-</p>\r
-</dd>\r
-<dt>\r
 -3, --3way\r
 </dt>\r
 <dd>\r
@@ -362,16 +354,16 @@ default.   You could use <tt>--no-utf8</tt> to override this.</p>
         When the patch does not apply cleanly, fall back on\r
         3-way merge, if the patch records the identity of blobs\r
         it is supposed to apply to, and we have those blobs\r
-        locally.\r
+        available locally.\r
 </p>\r
 </dd>\r
 <dt>\r
---skip\r
+-b, --binary\r
 </dt>\r
 <dd>\r
 <p>\r
-        Skip the current patch.  This is only meaningful when\r
-        restarting an aborted patch.\r
+        Pass <tt>--allow-binary-replacement</tt> flag to <tt>git-apply</tt>\r
+        (see <a href="git-apply.html">git-apply(1)</a>).\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -379,7 +371,8 @@ default.   You could use <tt>--no-utf8</tt> to override this.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        This flag is passed to the <tt>git-apply</tt> program that applies\r
+        This flag is passed to the <tt>git-apply</tt> (see <a href="git-apply.html">git-apply(1)</a>)\r
+        program that applies\r
         the patch.\r
 </p>\r
 </dd>\r
@@ -388,7 +381,8 @@ default.   You could use <tt>--no-utf8</tt> to override this.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        These flags are passed to the <tt>git-apply</tt> program that applies\r
+        These flags are passed to the <tt>git-apply</tt> (see <a href="git-apply.html">git-apply(1)</a>)\r
+        program that applies\r
         the patch.\r
 </p>\r
 </dd>\r
@@ -397,7 +391,16 @@ default.   You could use <tt>--no-utf8</tt> to override this.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        Run interactively, just like git-applymbox.\r
+        Run interactively.\r
+</p>\r
+</dd>\r
+<dt>\r
+--skip\r
+</dt>\r
+<dd>\r
+<p>\r
+        Skip the current patch.  This is only meaningful when\r
+        restarting an aborted patch.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -471,7 +474,7 @@ recover from this in one of two ways:</p>
 <ol>\r
 <li>\r
 <p>\r
-skip the current one by re-running the command with <em>--skip</em>\r
+skip the current patch by re-running the command with <em>--skip</em>\r
   option.\r
 </p>\r
 </li>\r
@@ -506,7 +509,7 @@ names.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 17-Apr-2007 08:27:39 UTC\r
+Last updated 15-May-2007 03:12:35 UTC\r
 </div>\r
 </div>\r
 </body>\r
index f0405a35e9aa34fe67b2ddf92052f35a2d706610..ba79773f79fc8823f1c611e51b163866ada26306 100644 (file)
@@ -9,9 +9,10 @@ git-am - Apply a series of patches from a mailbox
 SYNOPSIS
 --------
 [verse]
-'git-am' [--signoff] [--dotest=<dir>] [--utf8 | --no-utf8] [--binary] [--3way]
-         [--interactive] [--whitespace=<option>] [-C<n>] [-p<n>]
-        <mbox>...
+'git-am' [--signoff] [--dotest=<dir>] [--keep] [--utf8 | --no-utf8]
+         [--3way] [--interactive] [--binary]
+         [--whitespace=<option>] [-C<n>] [-p<n>]
+         <mbox>...
 'git-am' [--skip | --resolved]
 
 DESCRIPTION
@@ -40,7 +41,7 @@ OPTIONS
 -u, --utf8::
        Pass `-u` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
        The proposed commit log message taken from the e-mail
-       are re-coded into UTF-8 encoding (configuration variable
+       is re-coded into UTF-8 encoding (configuration variable
        `i18n.commitencoding` can be used to specify project's
        preferred encoding if it is not UTF-8).
 +
@@ -51,30 +52,32 @@ default.   You could use `--no-utf8` to override this.
        Pass `-n` flag to `git-mailinfo` (see
        gitlink:git-mailinfo[1]).
 
--b, --binary::
-       Pass `--allow-binary-replacement` flag to `git-apply`
-       (see gitlink:git-apply[1]).
-
 -3, --3way::
        When the patch does not apply cleanly, fall back on
        3-way merge, if the patch records the identity of blobs
        it is supposed to apply to, and we have those blobs
-       locally.
+       available locally.
 
---skip::
-       Skip the current patch.  This is only meaningful when
-       restarting an aborted patch.
+-b, --binary::
+       Pass `--allow-binary-replacement` flag to `git-apply`
+       (see gitlink:git-apply[1]).
 
 --whitespace=<option>::
-       This flag is passed to the `git-apply` program that applies
+       This flag is passed to the `git-apply` (see gitlink:git-apply[1])
+       program that applies
        the patch.
 
 -C<n>, -p<n>::
-       These flags are passed to the `git-apply` program that applies
+       These flags are passed to the `git-apply` (see gitlink:git-apply[1])
+       program that applies
        the patch.
 
 -i, --interactive::
-       Run interactively, just like git-applymbox.
+       Run interactively.
+
+--skip::
+       Skip the current patch.  This is only meaningful when
+       restarting an aborted patch.
 
 -r, --resolved::
        After a patch failure (e.g. attempting to apply
@@ -126,7 +129,7 @@ to crunch.  Upon seeing the first patch that does not apply, it
 aborts in the middle, just like 'git-applymbox' does.  You can
 recover from this in one of two ways:
 
-. skip the current one by re-running the command with '--skip'
+. skip the current patch by re-running the command with '--skip'
   option.
 
 . hand resolve the conflict in the working directory, and update
index f3af7b988a3db23d407c1e2250c920f16707e0d1..06e07918b7a39d8c3eb69a7f89f985313f849e4d 100644 (file)
@@ -304,7 +304,7 @@ current branch.</p>
         whitespaces, (3) <em>[</em> up to <em>]</em>, typically <em>[PATCH]</em>, and\r
         then prepends "[PATCH] ".  This flag forbids this\r
         munging, and is most useful when used to read back <em>git\r
-        format-patch --mbox</em> output.\r
+        format-patch -k</em> output.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -401,7 +401,7 @@ conversion, even with this flag.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 17-Apr-2007 08:27:39 UTC\r
+Last updated 15-May-2007 03:12:36 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 3bc92d8cf17297e7b4a88bd2aeb9339b83d9d283..ea919ba5d7e8a01cd2e5aa9116ff4bbcf9ddd1ea 100644 (file)
@@ -31,7 +31,7 @@ OPTIONS
        whitespaces, (3) '[' up to ']', typically '[PATCH]', and
        then prepends "[PATCH] ".  This flag forbids this
        munging, and is most useful when used to read back 'git
-       format-patch --mbox' output.
+       format-patch -k' output.
 
 -m::
        Patches are applied with `git-apply` command, and unless
index f2ba31c284e953f202117e35d7305866e6d64560..6de23cf57baaec8905007121d13c1b15c631d823 100644 (file)
@@ -756,18 +756,86 @@ separated with a single space are given.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        Pretty-prints the details of a commit.  <tt>--pretty</tt>\r
-        without an explicit <tt>=&lt;format&gt;</tt> defaults to <em>medium</em>.\r
-        If the commit is a merge, and if the pretty-format\r
-        is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is\r
-        inserted before the <em>Author:</em> line.  This line begins with\r
-        "Merge: " and the sha1s of ancestral commits are printed,\r
-        separated by spaces.  Note that the listed commits may not\r
-        necessarily be the list of the <strong>direct</strong> parent commits if you\r
-        have limited your view of history: for example, if you are\r
-        only interested in changes related to a certain directory or\r
-        file.  Here are some additional details for each format:\r
+        Pretty print the contents of the commit logs in a given format,\r
+        where <em>&lt;format&gt;</em> can be one of <em>oneline</em>, <em>short</em>, <em>medium</em>,\r
+        <em>full</em>, <em>fuller</em>, <em>email</em>, <em>raw</em> and <em>format:&lt;string&gt;</em>.\r
+        When left out the format default to <em>medium</em>.\r
 </p>\r
+</dd>\r
+<dt>\r
+--encoding[=&lt;encoding&gt;]\r
+</dt>\r
+<dd>\r
+<p>\r
+        The commit objects record the encoding used for the log message\r
+        in their encoding header; this option can be used to tell the\r
+        command to re-code the commit log message in the encoding\r
+        preferred by the user.  For non plumbing commands this\r
+        defaults to UTF-8.\r
+</p>\r
+</dd>\r
+<dt>\r
+--no-commit-id\r
+</dt>\r
+<dd>\r
+<p>\r
+        git-diff-tree outputs a line with the commit ID when\r
+        applicable.  This flag suppressed the commit ID output.\r
+</p>\r
+</dd>\r
+<dt>\r
+-c\r
+</dt>\r
+<dd>\r
+<p>\r
+        This flag changes the way a merge commit is displayed\r
+        (which means it is useful only when the command is given\r
+        one &lt;tree-ish&gt;, or <em>--stdin</em>).  It shows the differences\r
+        from each of the parents to the merge result simultaneously\r
+        instead of showing pairwise diff between a parent and the\r
+        result one at a time (which is what the <em>-m</em> option does).\r
+        Furthermore, it lists only files which were modified\r
+        from all parents.\r
+</p>\r
+</dd>\r
+<dt>\r
+--cc\r
+</dt>\r
+<dd>\r
+<p>\r
+        This flag changes the way a merge commit patch is displayed,\r
+        in a similar way to the <em>-c</em> option. It implies the <em>-c</em>\r
+        and <em>-p</em> options and further compresses the patch output\r
+        by omitting hunks that show differences from only one\r
+        parent, or show the same change from all but one parent\r
+        for an Octopus merge.  When this optimization makes all\r
+        hunks disappear, the commit itself and the commit log\r
+        message is not shown, just like in any other "empty diff" case.\r
+</p>\r
+</dd>\r
+<dt>\r
+--always\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show the commit itself and the commit log message even\r
+        if the diff itself is empty.\r
+</p>\r
+</dd>\r
+</dl>\r
+</div>\r
+<h2>PRETTY FORMATS</h2>\r
+<div class="sectionbody">\r
+<p>If the commit is a merge, and if the pretty-format\r
+is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is\r
+inserted before the <em>Author:</em> line.  This line begins with\r
+"Merge: " and the sha1s of ancestral commits are printed,\r
+separated by spaces.  Note that the listed commits may not\r
+necessarily be the list of the <strong>direct</strong> parent commits if you\r
+have limited your view of history: for example, if you are\r
+only interested in changes related to a certain directory or\r
+file.</p>\r
+<p>Here are some additional details for each format:</p>\r
 <ul>\r
 <li>\r
 <p>\r
@@ -865,7 +933,7 @@ Subject: [PATCH] &lt;title line&gt;</tt></pre>
 </div></div>\r
 <div class="literalblock">\r
 <div class="content">\r
-<pre><tt>full commit message&gt;</tt></pre>\r
+<pre><tt>&lt;full commit message&gt;</tt></pre>\r
 </div></div>\r
 </li>\r
 <li>\r
@@ -887,14 +955,14 @@ simplification into account.</p>
 you want to show. It works a little bit like printf format,\r
 with the notable exception that you get a newline with <em>%n</em>\r
 instead of <em>\n</em>.</p>\r
-</li>\r
-</ul>\r
-</dd>\r
-</dl>\r
-<p>E.g, <em>format:"The author of %h was %an, %ar%nThe title was &gt;&gt;%s&lt;&lt;"</em>\r
+<p>E.g, <em>format:"The author of %h was %an, %ar%nThe title was &gt;&gt;%s&lt;&lt;%n"</em>\r
 would show something like this:</p>\r
-<p>The author of fe6e0ee was Junio C Hamano, 23 hours ago\r
-The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>The author of fe6e0ee was Junio C Hamano, 23 hours ago\r
+The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;\r
+</tt></pre>\r
+</div></div>\r
 <p>The placeholders are:</p>\r
 <ul>\r
 <li>\r
@@ -1031,68 +1099,8 @@ The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff
 <p>\r
 <em>%n</em>: newline\r
 </p>\r
-<dl>\r
-<dt>\r
---encoding[=&lt;encoding&gt;]\r
-</dt>\r
-<dd>\r
-<p>\r
-        The commit objects record the encoding used for the log message\r
-        in their encoding header; this option can be used to tell the\r
-        command to re-code the commit log message in the encoding\r
-        preferred by the user.  For non plumbing commands this\r
-        defaults to UTF-8.\r
-</p>\r
-</dd>\r
-<dt>\r
---no-commit-id\r
-</dt>\r
-<dd>\r
-<p>\r
-        git-diff-tree outputs a line with the commit ID when\r
-        applicable.  This flag suppressed the commit ID output.\r
-</p>\r
-</dd>\r
-<dt>\r
--c\r
-</dt>\r
-<dd>\r
-<p>\r
-        This flag changes the way a merge commit is displayed\r
-        (which means it is useful only when the command is given\r
-        one &lt;tree-ish&gt;, or <em>--stdin</em>).  It shows the differences\r
-        from each of the parents to the merge result simultaneously\r
-        instead of showing pairwise diff between a parent and the\r
-        result one at a time (which is what the <em>-m</em> option does).\r
-        Furthermore, it lists only files which were modified\r
-        from all parents.\r
-</p>\r
-</dd>\r
-<dt>\r
---cc\r
-</dt>\r
-<dd>\r
-<p>\r
-        This flag changes the way a merge commit patch is displayed,\r
-        in a similar way to the <em>-c</em> option. It implies the <em>-c</em>\r
-        and <em>-p</em> options and further compresses the patch output\r
-        by omitting hunks that show differences from only one\r
-        parent, or show the same change from all but one parent\r
-        for an Octopus merge.  When this optimization makes all\r
-        hunks disappear, the commit itself and the commit log\r
-        message is not shown, just like in any other "empty diff" case.\r
-</p>\r
-</dd>\r
-<dt>\r
---always\r
-</dt>\r
-<dd>\r
-<p>\r
-        Show the commit itself and the commit log message even\r
-        if the diff itself is empty.\r
-</p>\r
-</dd>\r
-</dl>\r
+</li>\r
+</ul>\r
 </li>\r
 </ul>\r
 </div>\r
@@ -1508,7 +1516,7 @@ two unresolved merge parents with the working tree file
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 06-May-2007 08:52:35 UTC\r
+Last updated 15-May-2007 03:12:36 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 5d6e9dc751aef6e30582b399ae09f81c043e6de1..6e660e2d08c2d9d795b5ccfb91f755160cf58930 100644 (file)
@@ -73,7 +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.
 
-include::pretty-formats.txt[]
+include::pretty-options.txt[]
 
 --no-commit-id::
        git-diff-tree outputs a line with the commit ID when
@@ -104,6 +104,9 @@ include::pretty-formats.txt[]
        if the diff itself is empty.
 
 
+include::pretty-formats.txt[]
+
+
 Limiting Output
 ---------------
 If you're only interested in differences in a subset of files, for
index be935423fc67e4beff70ae71d6dd5a272ec44ac9..95955ff5b363b594c970d3cdb6dd59b2e988ea9e 100644 (file)
@@ -291,18 +291,103 @@ each commit introduces are shown.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        Pretty-prints the details of a commit.  <tt>--pretty</tt>\r
-        without an explicit <tt>=&lt;format&gt;</tt> defaults to <em>medium</em>.\r
-        If the commit is a merge, and if the pretty-format\r
-        is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is\r
-        inserted before the <em>Author:</em> line.  This line begins with\r
-        "Merge: " and the sha1s of ancestral commits are printed,\r
-        separated by spaces.  Note that the listed commits may not\r
-        necessarily be the list of the <strong>direct</strong> parent commits if you\r
-        have limited your view of history: for example, if you are\r
-        only interested in changes related to a certain directory or\r
-        file.  Here are some additional details for each format:\r
+        Pretty print the contents of the commit logs in a given format,\r
+        where <em>&lt;format&gt;</em> can be one of <em>oneline</em>, <em>short</em>, <em>medium</em>,\r
+        <em>full</em>, <em>fuller</em>, <em>email</em>, <em>raw</em> and <em>format:&lt;string&gt;</em>.\r
+        When left out the format default to <em>medium</em>.\r
 </p>\r
+</dd>\r
+<dt>\r
+--encoding[=&lt;encoding&gt;]\r
+</dt>\r
+<dd>\r
+<p>\r
+        The commit objects record the encoding used for the log message\r
+        in their encoding header; this option can be used to tell the\r
+        command to re-code the commit log message in the encoding\r
+        preferred by the user.  For non plumbing commands this\r
+        defaults to UTF-8.\r
+</p>\r
+</dd>\r
+<dt>\r
+-&lt;n&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        Limits the number of commits to show.\r
+</p>\r
+</dd>\r
+<dt>\r
+&lt;since&gt;..&lt;until&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show only commits between the named two commits.  When\r
+        either &lt;since&gt; or &lt;until&gt; is omitted, it defaults to\r
+        <tt>HEAD</tt>, i.e. the tip of the current branch.\r
+        For a more complete list of ways to spell &lt;since&gt;\r
+        and &lt;until&gt;, see "SPECIFYING REVISIONS" section in\r
+        <a href="git-rev-parse.html">git-rev-parse(1)</a>.\r
+</p>\r
+</dd>\r
+<dt>\r
+--first-parent\r
+</dt>\r
+<dd>\r
+<p>\r
+        Follow only the first parent commit upon seeing a merge\r
+        commit.  This  option gives a better overview of the\r
+        evolution of a particular branch.\r
+</p>\r
+</dd>\r
+<dt>\r
+-p\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show the change the commit introduces in a patch form.\r
+</p>\r
+</dd>\r
+<dt>\r
+-g, --walk-reflogs\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show commits as they were recorded in the reflog. The log contains\r
+        a record about how the tip of a reference was changed.\r
+        See also <a href="git-reflog.html">git-reflog(1)</a>.\r
+</p>\r
+</dd>\r
+<dt>\r
+--decorate\r
+</dt>\r
+<dd>\r
+<p>\r
+    Print out the ref names of any commits that are shown.\r
+</p>\r
+</dd>\r
+<dt>\r
+&lt;paths&gt;&#8230;\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show only commits that affect the specified paths.\r
+</p>\r
+</dd>\r
+</dl>\r
+</div>\r
+<h2>PRETTY FORMATS</h2>\r
+<div class="sectionbody">\r
+<p>If the commit is a merge, and if the pretty-format\r
+is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is\r
+inserted before the <em>Author:</em> line.  This line begins with\r
+"Merge: " and the sha1s of ancestral commits are printed,\r
+separated by spaces.  Note that the listed commits may not\r
+necessarily be the list of the <strong>direct</strong> parent commits if you\r
+have limited your view of history: for example, if you are\r
+only interested in changes related to a certain directory or\r
+file.</p>\r
+<p>Here are some additional details for each format:</p>\r
 <ul>\r
 <li>\r
 <p>\r
@@ -400,7 +485,7 @@ Subject: [PATCH] &lt;title line&gt;</tt></pre>
 </div></div>\r
 <div class="literalblock">\r
 <div class="content">\r
-<pre><tt>full commit message&gt;</tt></pre>\r
+<pre><tt>&lt;full commit message&gt;</tt></pre>\r
 </div></div>\r
 </li>\r
 <li>\r
@@ -422,14 +507,14 @@ simplification into account.</p>
 you want to show. It works a little bit like printf format,\r
 with the notable exception that you get a newline with <em>%n</em>\r
 instead of <em>\n</em>.</p>\r
-</li>\r
-</ul>\r
-</dd>\r
-</dl>\r
-<p>E.g, <em>format:"The author of %h was %an, %ar%nThe title was &gt;&gt;%s&lt;&lt;"</em>\r
+<p>E.g, <em>format:"The author of %h was %an, %ar%nThe title was &gt;&gt;%s&lt;&lt;%n"</em>\r
 would show something like this:</p>\r
-<p>The author of fe6e0ee was Junio C Hamano, 23 hours ago\r
-The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>The author of fe6e0ee was Junio C Hamano, 23 hours ago\r
+The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;\r
+</tt></pre>\r
+</div></div>\r
 <p>The placeholders are:</p>\r
 <ul>\r
 <li>\r
@@ -566,85 +651,8 @@ The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff
 <p>\r
 <em>%n</em>: newline\r
 </p>\r
-<dl>\r
-<dt>\r
---encoding[=&lt;encoding&gt;]\r
-</dt>\r
-<dd>\r
-<p>\r
-        The commit objects record the encoding used for the log message\r
-        in their encoding header; this option can be used to tell the\r
-        command to re-code the commit log message in the encoding\r
-        preferred by the user.  For non plumbing commands this\r
-        defaults to UTF-8.\r
-</p>\r
-</dd>\r
-<dt>\r
--&lt;n&gt;\r
-</dt>\r
-<dd>\r
-<p>\r
-        Limits the number of commits to show.\r
-</p>\r
-</dd>\r
-<dt>\r
-&lt;since&gt;..&lt;until&gt;\r
-</dt>\r
-<dd>\r
-<p>\r
-        Show only commits between the named two commits.  When\r
-        either &lt;since&gt; or &lt;until&gt; is omitted, it defaults to\r
-        <tt>HEAD</tt>, i.e. the tip of the current branch.\r
-        For a more complete list of ways to spell &lt;since&gt;\r
-        and &lt;until&gt;, see "SPECIFYING REVISIONS" section in\r
-        <a href="git-rev-parse.html">git-rev-parse(1)</a>.\r
-</p>\r
-</dd>\r
-<dt>\r
---first-parent\r
-</dt>\r
-<dd>\r
-<p>\r
-        Follow only the first parent commit upon seeing a merge\r
-        commit.  This  option gives a better overview of the\r
-        evolution of a particular branch.\r
-</p>\r
-</dd>\r
-<dt>\r
--p\r
-</dt>\r
-<dd>\r
-<p>\r
-        Show the change the commit introduces in a patch form.\r
-</p>\r
-</dd>\r
-<dt>\r
--g, --walk-reflogs\r
-</dt>\r
-<dd>\r
-<p>\r
-        Show commits as they were recorded in the reflog. The log contains\r
-        a record about how the tip of a reference was changed.\r
-        See also <a href="git-reflog.html">git-reflog(1)</a>.\r
-</p>\r
-</dd>\r
-<dt>\r
---decorate\r
-</dt>\r
-<dd>\r
-<p>\r
-    Print out the ref names of any commits that are shown.\r
-</p>\r
-</dd>\r
-<dt>\r
-&lt;paths&gt;&#8230;\r
-</dt>\r
-<dd>\r
-<p>\r
-        Show only commits that affect the specified paths.\r
-</p>\r
-</dd>\r
-</dl>\r
+</li>\r
+</ul>\r
 </li>\r
 </ul>\r
 </div>\r
@@ -779,7 +787,7 @@ reversible operation.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 10-May-2007 23:24:40 UTC\r
+Last updated 15-May-2007 03:12:36 UTC\r
 </div>\r
 </div>\r
 </body>\r
index dd06527a1e1b421ca867fa8bca0c36ccb75aeea6..0f353f6558e5843b1534f4cb9acd75746c313510 100644 (file)
@@ -25,7 +25,7 @@ This manual page describes only the most frequently used options.
 OPTIONS
 -------
 
-include::pretty-formats.txt[]
+include::pretty-options.txt[]
 
 -<n>::
        Limits the number of commits to show.
@@ -58,6 +58,9 @@ include::pretty-formats.txt[]
        Show only commits that affect the specified paths.
 
 
+include::pretty-formats.txt[]
+
+
 Examples
 --------
 git log --no-merges::
index 5b5b6d2c7f2a22aabace5a91493a824e0a37f588..5b24f53bdcf45ea1a6e5629bd57c7cb5c6d251e3 100644 (file)
@@ -297,7 +297,7 @@ command directly.  See <a href="git-am.html">git-am(1)</a> instead.</p>
         whitespaces, (3) <em>[</em> up to <em>]</em>, typically <em>[PATCH]</em>, and\r
         then prepends "[PATCH] ".  This flag forbids this\r
         munging, and is most useful when used to read back <em>git\r
-        format-patch --mbox</em> output.\r
+        format-patch -k</em> output.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -357,7 +357,7 @@ Junio C Hamano &lt;junkio@cox.net&gt;</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 04-Apr-2007 18:33:49 UTC\r
+Last updated 15-May-2007 03:12:37 UTC\r
 </div>\r
 </div>\r
 </body>\r
index ba18133ead23b0974b8198e25c28ccc746e99954..8eadcebfcf5c26c599cde0d939d1046de69f2335 100644 (file)
@@ -30,7 +30,7 @@ OPTIONS
        whitespaces, (3) '[' up to ']', typically '[PATCH]', and
        then prepends "[PATCH] ".  This flag forbids this
        munging, and is most useful when used to read back 'git
-       format-patch --mbox' output.
+       format-patch -k' output.
 
 -u::
        The commit log message, author name and author email are
index bd5c2cd130ac668fadfe78bc8ab0c42bca55ee5d..e672e5aa248aff4daaefe2b8ed62aaf0904e0f83 100644 (file)
@@ -347,282 +347,12 @@ more specialized family of commit log tools: <a href="git-log.html">git-log(1)</
 </dt>\r
 <dd>\r
 <p>\r
-        Pretty-prints the details of a commit.  <tt>--pretty</tt>\r
-        without an explicit <tt>=&lt;format&gt;</tt> defaults to <em>medium</em>.\r
-        If the commit is a merge, and if the pretty-format\r
-        is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is\r
-        inserted before the <em>Author:</em> line.  This line begins with\r
-        "Merge: " and the sha1s of ancestral commits are printed,\r
-        separated by spaces.  Note that the listed commits may not\r
-        necessarily be the list of the <strong>direct</strong> parent commits if you\r
-        have limited your view of history: for example, if you are\r
-        only interested in changes related to a certain directory or\r
-        file.  Here are some additional details for each format:\r
+        Pretty print the contents of the commit logs in a given format,\r
+        where <em>&lt;format&gt;</em> can be one of <em>oneline</em>, <em>short</em>, <em>medium</em>,\r
+        <em>full</em>, <em>fuller</em>, <em>email</em>, <em>raw</em> and <em>format:&lt;string&gt;</em>.\r
+        When left out the format default to <em>medium</em>.\r
 </p>\r
-<ul>\r
-<li>\r
-<p>\r
-<em>oneline</em>\r
-</p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>&lt;sha1&gt; &lt;title line&gt;</tt></pre>\r
-</div></div>\r
-<p>This is designed to be as compact as possible.</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>short</em>\r
-</p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>commit &lt;sha1&gt;\r
-Author: &lt;author&gt;</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>&lt;title line&gt;</tt></pre>\r
-</div></div>\r
-</li>\r
-<li>\r
-<p>\r
-<em>medium</em>\r
-</p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>commit &lt;sha1&gt;\r
-Author: &lt;author&gt;\r
-Date: &lt;date&gt;</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>&lt;title line&gt;</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>&lt;full commit message&gt;</tt></pre>\r
-</div></div>\r
-</li>\r
-<li>\r
-<p>\r
-<em>full</em>\r
-</p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>commit &lt;sha1&gt;\r
-Author: &lt;author&gt;\r
-Commit: &lt;committer&gt;</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>&lt;title line&gt;</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>&lt;full commit message&gt;</tt></pre>\r
-</div></div>\r
-</li>\r
-<li>\r
-<p>\r
-<em>fuller</em>\r
-</p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>commit &lt;sha1&gt;\r
-Author: &lt;author&gt;\r
-AuthorDate: &lt;date &amp; time&gt;\r
-Commit: &lt;committer&gt;\r
-CommitDate: &lt;date &amp; time&gt;</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>&lt;title line&gt;</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>&lt;full commit message&gt;</tt></pre>\r
-</div></div>\r
-</li>\r
-<li>\r
-<p>\r
-<em>email</em>\r
-</p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>From &lt;sha1&gt; &lt;date&gt;\r
-From: &lt;author&gt;\r
-Date: &lt;date &amp; time&gt;\r
-Subject: [PATCH] &lt;title line&gt;</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>full commit message&gt;</tt></pre>\r
-</div></div>\r
-</li>\r
-<li>\r
-<p>\r
-<em>raw</em>\r
-</p>\r
-<p>The <em>raw</em> format shows the entire commit exactly as\r
-stored in the commit object.  Notably, the SHA1s are\r
-displayed in full, regardless of whether --abbrev or\r
---no-abbrev are used, and <em>parents</em> information show the\r
-true parent commits, without taking grafts nor history\r
-simplification into account.</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>format:</em>\r
-</p>\r
-<p>The <em>format:</em> format allows you to specify which information\r
-you want to show. It works a little bit like printf format,\r
-with the notable exception that you get a newline with <em>%n</em>\r
-instead of <em>\n</em>.</p>\r
-</li>\r
-</ul>\r
 </dd>\r
-</dl>\r
-<p>E.g, <em>format:"The author of %h was %an, %ar%nThe title was &gt;&gt;%s&lt;&lt;"</em>\r
-would show something like this:</p>\r
-<p>The author of fe6e0ee was Junio C Hamano, 23 hours ago\r
-The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;</p>\r
-<p>The placeholders are:</p>\r
-<ul>\r
-<li>\r
-<p>\r
-<em>%H</em>: commit hash\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%h</em>: abbreviated commit hash\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%T</em>: tree hash\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%t</em>: abbreviated tree hash\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%P</em>: parent hashes\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%p</em>: abbreviated parent hashes\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%an</em>: author name\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%ae</em>: author email\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%ad</em>: author date\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%aD</em>: author date, RFC2822 style\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%ar</em>: author date, relative\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%at</em>: author date, UNIX timestamp\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%cn</em>: committer name\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%ce</em>: committer email\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%cd</em>: committer date\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%cD</em>: committer date, RFC2822 style\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%cr</em>: committer date, relative\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%ct</em>: committer date, UNIX timestamp\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%e</em>: encoding\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%s</em>: subject\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%b</em>: body\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%Cred</em>: switch color to red\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%Cgreen</em>: switch color to green\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%Cblue</em>: switch color to blue\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%Creset</em>: reset color\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%m</em>: left, right or boundary mark\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-<em>%n</em>: newline\r
-</p>\r
-<dl>\r
 <dt>\r
 --encoding[=&lt;encoding&gt;]\r
 </dt>\r
@@ -707,8 +437,6 @@ e.g. "2 hours ago".</p>
 </div></div>\r
 </dd>\r
 </dl>\r
-</li>\r
-</ul>\r
 <h3>Diff Formatting</h3>\r
 <p>Below are listed options that control the formatting of diff output.\r
 Some of them are specific to <a href="git-rev-list.html">git-rev-list(1)</a>, however other diff\r
@@ -719,319 +447,599 @@ options may be given. See <a href="git-diff-files.html">git-diff-files(1)</a> fo
 </dt>\r
 <dd>\r
 <p>\r
-        This flag changes the way a merge commit is displayed.  It shows\r
-        the differences from each of the parents to the merge result\r
-        simultaneously instead of showing pairwise diff between a parent\r
-        and the result one at a time. Furthermore, it lists only files\r
-        which were modified from all parents.\r
+        This flag changes the way a merge commit is displayed.  It shows\r
+        the differences from each of the parents to the merge result\r
+        simultaneously instead of showing pairwise diff between a parent\r
+        and the result one at a time. Furthermore, it lists only files\r
+        which were modified from all parents.\r
+</p>\r
+</dd>\r
+<dt>\r
+--cc\r
+</dt>\r
+<dd>\r
+<p>\r
+        This flag implies the <em>-c</em> options and further compresses the\r
+        patch output by omitting hunks that show differences from only\r
+        one parent, or show the same change from all but one parent for\r
+        an Octopus merge.\r
+</p>\r
+</dd>\r
+<dt>\r
+-r\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show recursive diffs.\r
+</p>\r
+</dd>\r
+<dt>\r
+-t\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show the tree objects in the diff output. This implies <em>-r</em>.\r
+</p>\r
+</dd>\r
+</dl>\r
+<h3>Commit Limiting</h3>\r
+<p>Besides specifying a range of commits that should be listed using the\r
+special notations explained in the description, additional commit\r
+limiting may be applied.</p>\r
+<dl>\r
+<dt>\r
+-n <em>number</em>, --max-count=<em>number</em>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Limit the number of commits output.\r
+</p>\r
+</dd>\r
+<dt>\r
+--skip=<em>number</em>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Skip <em>number</em> commits before starting to show the commit output.\r
+</p>\r
+</dd>\r
+<dt>\r
+--since=<em>date</em>, --after=<em>date</em>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show commits more recent than a specific date.\r
+</p>\r
+</dd>\r
+<dt>\r
+--until=<em>date</em>, --before=<em>date</em>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show commits older than a specific date.\r
+</p>\r
+</dd>\r
+<dt>\r
+--max-age=<em>timestamp</em>, --min-age=<em>timestamp</em>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Limit the commits output to specified time range.\r
+</p>\r
+</dd>\r
+<dt>\r
+--author=<em>pattern</em>, --committer=<em>pattern</em>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Limit the commits output to ones with author/committer\r
+        header lines that match the specified pattern.\r
+</p>\r
+</dd>\r
+<dt>\r
+--grep=<em>pattern</em>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Limit the commits output to ones with log message that\r
+        matches the specified pattern.\r
+</p>\r
+</dd>\r
+<dt>\r
+--remove-empty\r
+</dt>\r
+<dd>\r
+<p>\r
+        Stop when a given path disappears from the tree.\r
+</p>\r
+</dd>\r
+<dt>\r
+--no-merges\r
+</dt>\r
+<dd>\r
+<p>\r
+        Do not print commits with more than one parent.\r
+</p>\r
+</dd>\r
+<dt>\r
+--not\r
+</dt>\r
+<dd>\r
+<p>\r
+        Reverses the meaning of the <em>^</em> prefix (or lack thereof)\r
+        for all following revision specifiers, up to the next <em>--not</em>.\r
+</p>\r
+</dd>\r
+<dt>\r
+--all\r
+</dt>\r
+<dd>\r
+<p>\r
+        Pretend as if all the refs in <tt>$GIT_DIR/refs/</tt> are listed on the\r
+        command line as <em>&lt;commit&gt;</em>.\r
+</p>\r
+</dd>\r
+<dt>\r
+--stdin\r
+</dt>\r
+<dd>\r
+<p>\r
+        In addition to the <em>&lt;commit&gt;</em> listed on the command\r
+        line, read them from the standard input.\r
+</p>\r
+</dd>\r
+<dt>\r
+--cherry-pick\r
+</dt>\r
+<dd>\r
+<p>\r
+        Omit any commit that introduces the same change as\r
+        another commit on the "other side" when the set of\r
+        commits are limited with symmetric difference.<br />\r
+For example, if you have two branches, <tt>A</tt> and <tt>B</tt>, a usual way\r
+to list all commits on only one side of them is with\r
+<tt>--left-right</tt>, like the example above in the description of\r
+that option.  It however shows the commits that were cherry-picked\r
+from the other branch (for example, "3rd on b" may be cherry-picked\r
+from branch A).  With this option, such pairs of commits are\r
+excluded from the output.\r
+</p>\r
+</dd>\r
+<dt>\r
+-g, --walk-reflogs\r
+</dt>\r
+<dd>\r
+<p>\r
+        Instead of walking the commit ancestry chain, walk\r
+        reflog entries from the most recent one to older ones.\r
+        When this option is used you cannot specify commits to\r
+        exclude (that is, <em>^commit</em>, <em>commit1..commit2</em>,\r
+        nor <em>commit1&#8230;commit2</em> notations cannot be used).<br />\r
+With <em>--pretty</em> format other than oneline (for obvious reasons),\r
+this causes the output to have two extra lines of information\r
+used in the output.  When the starting commit is specified as\r
+instead.  Under <em>--pretty=oneline</em>, the commit message is\r
+prefixed with this information on the same line.\r
+</p>\r
+</dd>\r
+<dt>\r
+--merge\r
+</dt>\r
+<dd>\r
+<p>\r
+        After a failed merge, show refs that touch files having a\r
+        conflict and don't exist on all heads to merge.\r
+</p>\r
+</dd>\r
+<dt>\r
+--boundary\r
+</dt>\r
+<dd>\r
+<p>\r
+        Output uninteresting commits at the boundary, which are usually\r
+        not shown.\r
 </p>\r
 </dd>\r
 <dt>\r
---cc\r
+--dense, --sparse\r
 </dt>\r
 <dd>\r
 <p>\r
-        This flag implies the <em>-c</em> options and further compresses the\r
-        patch output by omitting hunks that show differences from only\r
-        one parent, or show the same change from all but one parent for\r
-        an Octopus merge.\r
+When optional paths are given, the default behaviour (<em>--dense</em>) is to\r
+only output commits that changes at least one of them, and also ignore\r
+merges that do not touch the given paths.\r
 </p>\r
+<p>Use the <em>--sparse</em> flag to makes the command output all eligible commits\r
+(still subject to count and age limitation), but apply merge\r
+simplification nevertheless.</p>\r
 </dd>\r
 <dt>\r
--r\r
+--bisect\r
 </dt>\r
 <dd>\r
 <p>\r
-        Show recursive diffs.\r
+Limit output to the one commit object which is roughly halfway between\r
+the included and excluded commits. Thus, if\r
 </p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>        $ git-rev-list --bisect foo ^bar ^baz</tt></pre>\r
+</div></div>\r
+<p>outputs <em>midpoint</em>, the output of the two commands</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>        $ git-rev-list foo ^midpoint\r
+        $ git-rev-list midpoint ^bar ^baz</tt></pre>\r
+</div></div>\r
+<p>would be of roughly the same length.  Finding the change which\r
+introduces a regression is thus reduced to a binary search: repeatedly\r
+generate and test new 'midpoint's until the commit chain is of length\r
+one.</p>\r
 </dd>\r
 <dt>\r
--t\r
+--bisect-vars\r
 </dt>\r
 <dd>\r
 <p>\r
-        Show the tree objects in the diff output. This implies <em>-r</em>.\r
+This calculates the same as <tt>--bisect</tt>, but outputs text ready\r
+to be eval'ed by the shell. These lines will assign the name of\r
+the midpoint revision to the variable <tt>bisect_rev</tt>, and the\r
+expected number of commits to be tested after <tt>bisect_rev</tt> is\r
+tested to <tt>bisect_nr</tt>, the expected number of commits to be\r
+tested if <tt>bisect_rev</tt> turns out to be good to <tt>bisect_good</tt>,\r
+the expected number of commits to be tested if <tt>bisect_rev</tt>\r
+turns out to be bad to <tt>bisect_bad</tt>, and the number of commits\r
+we are bisecting right now to <tt>bisect_all</tt>.\r
 </p>\r
 </dd>\r
 </dl>\r
-<h3>Commit Limiting</h3>\r
-<p>Besides specifying a range of commits that should be listed using the\r
-special notations explained in the description, additional commit\r
-limiting may be applied.</p>\r
+<h3>Commit Ordering</h3>\r
+<p>By default, the commits are shown in reverse chronological order.</p>\r
 <dl>\r
 <dt>\r
--n <em>number</em>, --max-count=<em>number</em>\r
+--topo-order\r
 </dt>\r
 <dd>\r
 <p>\r
-        Limit the number of commits output.\r
+        This option makes them appear in topological order (i.e.\r
+        descendant commits are shown before their parents).\r
 </p>\r
 </dd>\r
 <dt>\r
---skip=<em>number</em>\r
+--date-order\r
 </dt>\r
 <dd>\r
 <p>\r
-        Skip <em>number</em> commits before starting to show the commit output.\r
+        This option is similar to <em>--topo-order</em> in the sense that no\r
+        parent comes before all of its children, but otherwise things\r
+        are still ordered in the commit timestamp order.\r
 </p>\r
 </dd>\r
 <dt>\r
---since=<em>date</em>, --after=<em>date</em>\r
+--reverse\r
 </dt>\r
 <dd>\r
 <p>\r
-        Show commits more recent than a specific date.\r
+        Output the commits in reverse order.\r
 </p>\r
 </dd>\r
+</dl>\r
+<h3>Object Traversal</h3>\r
+<p>These options are mostly targeted for packing of git repositories.</p>\r
+<dl>\r
 <dt>\r
---until=<em>date</em>, --before=<em>date</em>\r
+--objects\r
 </dt>\r
 <dd>\r
 <p>\r
-        Show commits older than a specific date.\r
+        Print the object IDs of any object referenced by the listed\r
+        commits.  <em>git-rev-list --objects foo ^bar</em> thus means "send me\r
+        all object IDs which I need to download if I have the commit\r
+        object <em>bar</em>, but not <em>foo</em>".\r
 </p>\r
 </dd>\r
 <dt>\r
---max-age=<em>timestamp</em>, --min-age=<em>timestamp</em>\r
+--objects-edge\r
 </dt>\r
 <dd>\r
 <p>\r
-        Limit the commits output to specified time range.\r
+        Similar to <em>--objects</em>, but also print the IDs of excluded\r
+        commits prefixed with a "-" character.  This is used by\r
+        <a href="git-pack-objects.html">git-pack-objects(1)</a> to build "thin" pack, which records\r
+        objects in deltified form based on objects contained in these\r
+        excluded commits to reduce network traffic.\r
 </p>\r
 </dd>\r
 <dt>\r
---author=<em>pattern</em>, --committer=<em>pattern</em>\r
+--unpacked\r
 </dt>\r
 <dd>\r
 <p>\r
-        Limit the commits output to ones with author/committer\r
-        header lines that match the specified pattern.\r
+        Only useful with <em>--objects</em>; print the object IDs that are not\r
+        in packs.\r
+</p>\r
+</dd>\r
+</dl>\r
+</div>\r
+<h2>PRETTY FORMATS</h2>\r
+<div class="sectionbody">\r
+<p>If the commit is a merge, and if the pretty-format\r
+is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is\r
+inserted before the <em>Author:</em> line.  This line begins with\r
+"Merge: " and the sha1s of ancestral commits are printed,\r
+separated by spaces.  Note that the listed commits may not\r
+necessarily be the list of the <strong>direct</strong> parent commits if you\r
+have limited your view of history: for example, if you are\r
+only interested in changes related to a certain directory or\r
+file.</p>\r
+<p>Here are some additional details for each format:</p>\r
+<ul>\r
+<li>\r
+<p>\r
+<em>oneline</em>\r
+</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>&lt;sha1&gt; &lt;title line&gt;</tt></pre>\r
+</div></div>\r
+<p>This is designed to be as compact as possible.</p>\r
+</li>\r
+<li>\r
+<p>\r
+<em>short</em>\r
+</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>commit &lt;sha1&gt;\r
+Author: &lt;author&gt;</tt></pre>\r
+</div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>&lt;title line&gt;</tt></pre>\r
+</div></div>\r
+</li>\r
+<li>\r
+<p>\r
+<em>medium</em>\r
+</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>commit &lt;sha1&gt;\r
+Author: &lt;author&gt;\r
+Date: &lt;date&gt;</tt></pre>\r
+</div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>&lt;title line&gt;</tt></pre>\r
+</div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>&lt;full commit message&gt;</tt></pre>\r
+</div></div>\r
+</li>\r
+<li>\r
+<p>\r
+<em>full</em>\r
+</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>commit &lt;sha1&gt;\r
+Author: &lt;author&gt;\r
+Commit: &lt;committer&gt;</tt></pre>\r
+</div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>&lt;title line&gt;</tt></pre>\r
+</div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>&lt;full commit message&gt;</tt></pre>\r
+</div></div>\r
+</li>\r
+<li>\r
+<p>\r
+<em>fuller</em>\r
+</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>commit &lt;sha1&gt;\r
+Author: &lt;author&gt;\r
+AuthorDate: &lt;date &amp; time&gt;\r
+Commit: &lt;committer&gt;\r
+CommitDate: &lt;date &amp; time&gt;</tt></pre>\r
+</div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>&lt;title line&gt;</tt></pre>\r
+</div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>&lt;full commit message&gt;</tt></pre>\r
+</div></div>\r
+</li>\r
+<li>\r
+<p>\r
+<em>email</em>\r
+</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>From &lt;sha1&gt; &lt;date&gt;\r
+From: &lt;author&gt;\r
+Date: &lt;date &amp; time&gt;\r
+Subject: [PATCH] &lt;title line&gt;</tt></pre>\r
+</div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>&lt;full commit message&gt;</tt></pre>\r
+</div></div>\r
+</li>\r
+<li>\r
+<p>\r
+<em>raw</em>\r
+</p>\r
+<p>The <em>raw</em> format shows the entire commit exactly as\r
+stored in the commit object.  Notably, the SHA1s are\r
+displayed in full, regardless of whether --abbrev or\r
+--no-abbrev are used, and <em>parents</em> information show the\r
+true parent commits, without taking grafts nor history\r
+simplification into account.</p>\r
+</li>\r
+<li>\r
+<p>\r
+<em>format:</em>\r
+</p>\r
+<p>The <em>format:</em> format allows you to specify which information\r
+you want to show. It works a little bit like printf format,\r
+with the notable exception that you get a newline with <em>%n</em>\r
+instead of <em>\n</em>.</p>\r
+<p>E.g, <em>format:"The author of %h was %an, %ar%nThe title was &gt;&gt;%s&lt;&lt;%n"</em>\r
+would show something like this:</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>The author of fe6e0ee was Junio C Hamano, 23 hours ago\r
+The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;\r
+</tt></pre>\r
+</div></div>\r
+<p>The placeholders are:</p>\r
+<ul>\r
+<li>\r
+<p>\r
+<em>%H</em>: commit hash\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<em>%h</em>: abbreviated commit hash\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<em>%T</em>: tree hash\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<em>%t</em>: abbreviated tree hash\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<em>%P</em>: parent hashes\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<em>%p</em>: abbreviated parent hashes\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<em>%an</em>: author name\r
 </p>\r
-</dd>\r
-<dt>\r
---grep=<em>pattern</em>\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        Limit the commits output to ones with log message that\r
-        matches the specified pattern.\r
+<em>%ae</em>: author email\r
 </p>\r
-</dd>\r
-<dt>\r
---remove-empty\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        Stop when a given path disappears from the tree.\r
+<em>%ad</em>: author date\r
 </p>\r
-</dd>\r
-<dt>\r
---no-merges\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        Do not print commits with more than one parent.\r
+<em>%aD</em>: author date, RFC2822 style\r
 </p>\r
-</dd>\r
-<dt>\r
---not\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        Reverses the meaning of the <em>^</em> prefix (or lack thereof)\r
-        for all following revision specifiers, up to the next <em>--not</em>.\r
+<em>%ar</em>: author date, relative\r
 </p>\r
-</dd>\r
-<dt>\r
---all\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        Pretend as if all the refs in <tt>$GIT_DIR/refs/</tt> are listed on the\r
-        command line as <em>&lt;commit&gt;</em>.\r
+<em>%at</em>: author date, UNIX timestamp\r
 </p>\r
-</dd>\r
-<dt>\r
---stdin\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        In addition to the <em>&lt;commit&gt;</em> listed on the command\r
-        line, read them from the standard input.\r
+<em>%cn</em>: committer name\r
 </p>\r
-</dd>\r
-<dt>\r
---cherry-pick\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        Omit any commit that introduces the same change as\r
-        another commit on the "other side" when the set of\r
-        commits are limited with symmetric difference.<br />\r
-For example, if you have two branches, <tt>A</tt> and <tt>B</tt>, a usual way\r
-to list all commits on only one side of them is with\r
-<tt>--left-right</tt>, like the example above in the description of\r
-that option.  It however shows the commits that were cherry-picked\r
-from the other branch (for example, "3rd on b" may be cherry-picked\r
-from branch A).  With this option, such pairs of commits are\r
-excluded from the output.\r
+<em>%ce</em>: committer email\r
 </p>\r
-</dd>\r
-<dt>\r
--g, --walk-reflogs\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        Instead of walking the commit ancestry chain, walk\r
-        reflog entries from the most recent one to older ones.\r
-        When this option is used you cannot specify commits to\r
-        exclude (that is, <em>^commit</em>, <em>commit1..commit2</em>,\r
-        nor <em>commit1&#8230;commit2</em> notations cannot be used).<br />\r
-With <em>--pretty</em> format other than oneline (for obvious reasons),\r
-this causes the output to have two extra lines of information\r
-used in the output.  When the starting commit is specified as\r
-instead.  Under <em>--pretty=oneline</em>, the commit message is\r
-prefixed with this information on the same line.\r
+<em>%cd</em>: committer date\r
 </p>\r
-</dd>\r
-<dt>\r
---merge\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        After a failed merge, show refs that touch files having a\r
-        conflict and don't exist on all heads to merge.\r
+<em>%cD</em>: committer date, RFC2822 style\r
 </p>\r
-</dd>\r
-<dt>\r
---boundary\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        Output uninteresting commits at the boundary, which are usually\r
-        not shown.\r
+<em>%cr</em>: committer date, relative\r
 </p>\r
-</dd>\r
-<dt>\r
---dense, --sparse\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-When optional paths are given, the default behaviour (<em>--dense</em>) is to\r
-only output commits that changes at least one of them, and also ignore\r
-merges that do not touch the given paths.\r
+<em>%ct</em>: committer date, UNIX timestamp\r
 </p>\r
-<p>Use the <em>--sparse</em> flag to makes the command output all eligible commits\r
-(still subject to count and age limitation), but apply merge\r
-simplification nevertheless.</p>\r
-</dd>\r
-<dt>\r
---bisect\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-Limit output to the one commit object which is roughly halfway between\r
-the included and excluded commits. Thus, if\r
+<em>%e</em>: encoding\r
 </p>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><tt>        $ git-rev-list --bisect foo ^bar ^baz</tt></pre>\r
-</div></div>\r
-<p>outputs <em>midpoint</em>, the output of the two commands</p>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><tt>        $ git-rev-list foo ^midpoint\r
-        $ git-rev-list midpoint ^bar ^baz</tt></pre>\r
-</div></div>\r
-<p>would be of roughly the same length.  Finding the change which\r
-introduces a regression is thus reduced to a binary search: repeatedly\r
-generate and test new 'midpoint's until the commit chain is of length\r
-one.</p>\r
-</dd>\r
-<dt>\r
---bisect-vars\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-This calculates the same as <tt>--bisect</tt>, but outputs text ready\r
-to be eval'ed by the shell. These lines will assign the name of\r
-the midpoint revision to the variable <tt>bisect_rev</tt>, and the\r
-expected number of commits to be tested after <tt>bisect_rev</tt> is\r
-tested to <tt>bisect_nr</tt>, the expected number of commits to be\r
-tested if <tt>bisect_rev</tt> turns out to be good to <tt>bisect_good</tt>,\r
-the expected number of commits to be tested if <tt>bisect_rev</tt>\r
-turns out to be bad to <tt>bisect_bad</tt>, and the number of commits\r
-we are bisecting right now to <tt>bisect_all</tt>.\r
+<em>%s</em>: subject\r
 </p>\r
-</dd>\r
-</dl>\r
-<h3>Commit Ordering</h3>\r
-<p>By default, the commits are shown in reverse chronological order.</p>\r
-<dl>\r
-<dt>\r
---topo-order\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        This option makes them appear in topological order (i.e.\r
-        descendant commits are shown before their parents).\r
+<em>%b</em>: body\r
 </p>\r
-</dd>\r
-<dt>\r
---date-order\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        This option is similar to <em>--topo-order</em> in the sense that no\r
-        parent comes before all of its children, but otherwise things\r
-        are still ordered in the commit timestamp order.\r
+<em>%Cred</em>: switch color to red\r
 </p>\r
-</dd>\r
-<dt>\r
---reverse\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        Output the commits in reverse order.\r
+<em>%Cgreen</em>: switch color to green\r
 </p>\r
-</dd>\r
-</dl>\r
-<h3>Object Traversal</h3>\r
-<p>These options are mostly targeted for packing of git repositories.</p>\r
-<dl>\r
-<dt>\r
---objects\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        Print the object IDs of any object referenced by the listed\r
-        commits.  <em>git-rev-list --objects foo ^bar</em> thus means "send me\r
-        all object IDs which I need to download if I have the commit\r
-        object <em>bar</em>, but not <em>foo</em>".\r
+<em>%Cblue</em>: switch color to blue\r
 </p>\r
-</dd>\r
-<dt>\r
---objects-edge\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        Similar to <em>--objects</em>, but also print the IDs of excluded\r
-        commits prefixed with a "-" character.  This is used by\r
-        <a href="git-pack-objects.html">git-pack-objects(1)</a> to build "thin" pack, which records\r
-        objects in deltified form based on objects contained in these\r
-        excluded commits to reduce network traffic.\r
+<em>%Creset</em>: reset color\r
 </p>\r
-</dd>\r
-<dt>\r
---unpacked\r
-</dt>\r
-<dd>\r
+</li>\r
+<li>\r
 <p>\r
-        Only useful with <em>--objects</em>; print the object IDs that are not\r
-        in packs.\r
+<em>%m</em>: left, right or boundary mark\r
 </p>\r
-</dd>\r
-</dl>\r
+</li>\r
+<li>\r
+<p>\r
+<em>%n</em>: newline\r
+</p>\r
+</li>\r
+</ul>\r
+</li>\r
+</ul>\r
 </div>\r
 <h2>Author</h2>\r
 <div class="sectionbody">\r
@@ -1048,7 +1056,7 @@ and the git-list &lt;git@vger.kernel.org&gt;.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 26-Apr-2007 07:19:26 UTC\r
+Last updated 15-May-2007 03:12:37 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 1b12b4f2a45e5650be067a3b05ce56c17a5422fc..ab90a22f11bbc92b4397135dac062cbfd7474bae 100644 (file)
@@ -87,7 +87,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]
 
-include::pretty-formats.txt[]
+include::pretty-options.txt[]
 
 --relative-date::
 
@@ -367,6 +367,10 @@ These options are mostly targeted for packing of git repositories.
        Only useful with '--objects'; print the object IDs that are not
        in packs.
 
+
+include::pretty-formats.txt[]
+
+
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>
index 89d00eb3bf1b31f67e072a6a8b8c7fa11b85ab8b..2731ef5e9ca656abcea96834b0d42ecb719d5b8e 100644 (file)
@@ -306,18 +306,38 @@ control how the changes the commit introduces are shown.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        Pretty-prints the details of a commit.  <tt>--pretty</tt>\r
-        without an explicit <tt>=&lt;format&gt;</tt> defaults to <em>medium</em>.\r
-        If the commit is a merge, and if the pretty-format\r
-        is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is\r
-        inserted before the <em>Author:</em> line.  This line begins with\r
-        "Merge: " and the sha1s of ancestral commits are printed,\r
-        separated by spaces.  Note that the listed commits may not\r
-        necessarily be the list of the <strong>direct</strong> parent commits if you\r
-        have limited your view of history: for example, if you are\r
-        only interested in changes related to a certain directory or\r
-        file.  Here are some additional details for each format:\r
+        Pretty print the contents of the commit logs in a given format,\r
+        where <em>&lt;format&gt;</em> can be one of <em>oneline</em>, <em>short</em>, <em>medium</em>,\r
+        <em>full</em>, <em>fuller</em>, <em>email</em>, <em>raw</em> and <em>format:&lt;string&gt;</em>.\r
+        When left out the format default to <em>medium</em>.\r
 </p>\r
+</dd>\r
+<dt>\r
+--encoding[=&lt;encoding&gt;]\r
+</dt>\r
+<dd>\r
+<p>\r
+        The commit objects record the encoding used for the log message\r
+        in their encoding header; this option can be used to tell the\r
+        command to re-code the commit log message in the encoding\r
+        preferred by the user.  For non plumbing commands this\r
+        defaults to UTF-8.\r
+</p>\r
+</dd>\r
+</dl>\r
+</div>\r
+<h2>PRETTY FORMATS</h2>\r
+<div class="sectionbody">\r
+<p>If the commit is a merge, and if the pretty-format\r
+is not <em>oneline</em>, <em>email</em> or <em>raw</em>, an additional line is\r
+inserted before the <em>Author:</em> line.  This line begins with\r
+"Merge: " and the sha1s of ancestral commits are printed,\r
+separated by spaces.  Note that the listed commits may not\r
+necessarily be the list of the <strong>direct</strong> parent commits if you\r
+have limited your view of history: for example, if you are\r
+only interested in changes related to a certain directory or\r
+file.</p>\r
+<p>Here are some additional details for each format:</p>\r
 <ul>\r
 <li>\r
 <p>\r
@@ -415,7 +435,7 @@ Subject: [PATCH] &lt;title line&gt;</tt></pre>
 </div></div>\r
 <div class="literalblock">\r
 <div class="content">\r
-<pre><tt>full commit message&gt;</tt></pre>\r
+<pre><tt>&lt;full commit message&gt;</tt></pre>\r
 </div></div>\r
 </li>\r
 <li>\r
@@ -437,14 +457,14 @@ simplification into account.</p>
 you want to show. It works a little bit like printf format,\r
 with the notable exception that you get a newline with <em>%n</em>\r
 instead of <em>\n</em>.</p>\r
-</li>\r
-</ul>\r
-</dd>\r
-</dl>\r
-<p>E.g, <em>format:"The author of %h was %an, %ar%nThe title was &gt;&gt;%s&lt;&lt;"</em>\r
+<p>E.g, <em>format:"The author of %h was %an, %ar%nThe title was &gt;&gt;%s&lt;&lt;%n"</em>\r
 would show something like this:</p>\r
-<p>The author of fe6e0ee was Junio C Hamano, 23 hours ago\r
-The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>The author of fe6e0ee was Junio C Hamano, 23 hours ago\r
+The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff input.&lt;&lt;\r
+</tt></pre>\r
+</div></div>\r
 <p>The placeholders are:</p>\r
 <ul>\r
 <li>\r
@@ -581,20 +601,8 @@ The title was &gt;&gt;t4119: test autocomputing -p&lt;n&gt; for traditional diff
 <p>\r
 <em>%n</em>: newline\r
 </p>\r
-<dl>\r
-<dt>\r
---encoding[=&lt;encoding&gt;]\r
-</dt>\r
-<dd>\r
-<p>\r
-        The commit objects record the encoding used for the log message\r
-        in their encoding header; this option can be used to tell the\r
-        command to re-code the commit log message in the encoding\r
-        preferred by the user.  For non plumbing commands this\r
-        defaults to UTF-8.\r
-</p>\r
-</dd>\r
-</dl>\r
+</li>\r
+</ul>\r
 </li>\r
 </ul>\r
 </div>\r
@@ -731,7 +739,7 @@ Johannes Schindelin &lt;Johannes.Schindelin@gmx.de&gt;.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 14-Apr-2007 16:21:46 UTC\r
+Last updated 15-May-2007 03:12:38 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 5a219ab5776c719190095ab4e9af95514a888ea3..34c5caf2d08324cc1595013cbdcd40d89d7a1968 100644 (file)
@@ -38,6 +38,9 @@ OPTIONS
        For a more complete list of ways to spell object names, see
        "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
 
+include::pretty-options.txt[]
+
+
 include::pretty-formats.txt[]
 
 
index 770fcdb3ad1a2fb03b7a5e444c8be3370ed45a2b..46825d92122342e9dda4777dd96342bb6930c5cc 100644 (file)
@@ -414,11 +414,11 @@ converted to LF upon checkin, but there is no conversion done
 upon checkout.</p>\r
 <h4><tt>ident</tt></h4>\r
 <p>When the attribute <tt>ident</tt> is set to a path, git replaces\r
-<tt>$ident$</tt> in the blob object with <tt>$ident:</tt>, followed by\r
+<tt>$Id$</tt> in the blob object with <tt>$Id:</tt>, followed by\r
 40-character hexadecimal blob object name, followed by a dollar\r
 sign <tt>$</tt> upon checkout.  Any byte sequence that begins with\r
-<tt>$ident:</tt> and ends with <tt>$</tt> in the worktree file is replaced\r
-with <tt>$ident$</tt> upon check-in.</p>\r
+<tt>$Id:</tt> and ends with <tt>$</tt> in the worktree file is replaced\r
+with <tt>$Id$</tt> upon check-in.</p>\r
 <h4>Interaction between checkin/checkout attributes</h4>\r
 <p>In the check-in codepath, the worktree file is first converted\r
 with <tt>ident</tt> (if specified), and then with <tt>crlf</tt> (again, if\r
@@ -658,7 +658,7 @@ frotz   unspecified</tt></pre>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 29-Apr-2007 18:29:52 UTC\r
+Last updated 15-May-2007 03:12:38 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 87723105d1aeeab3cc9918ffc80503f4291e749c..d3ac9c718147042a89db90a87d75fee34e778e5a 100644 (file)
@@ -138,11 +138,11 @@ upon checkout.
 ^^^^^^^
 
 When the attribute `ident` is set to a path, git replaces
-`$ident$` in the blob object with `$ident:`, followed by
+`$Id$` in the blob object with `$Id:`, followed by
 40-character hexadecimal blob object name, followed by a dollar
 sign `$` upon checkout.  Any byte sequence that begins with
-`$ident:` and ends with `$` in the worktree file is replaced
-with `$ident$` upon check-in.
+`$Id:` and ends with `$` in the worktree file is replaced
+with `$Id$` upon check-in.
 
 
 Interaction between checkin/checkout attributes
index d7ffc21ddf1e1241d8c485920e6ce56fe38c3f35..d922e8e86c173491fc492d3060bf92f4ee7b6c2d 100644 (file)
@@ -1,31 +1,32 @@
---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'
+PRETTY FORMATS
+--------------
+
+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'
+* 'short'
 
          commit <sha1>
          Author: <author>
 
              <title line>
 
-        * 'medium'
+* 'medium'
 
          commit <sha1>
          Author: <author>
@@ -35,7 +36,7 @@ This is designed to be as compact as possible.
 
              <full commit message>
 
-        * 'full'
+* 'full'
 
          commit <sha1>
          Author: <author>
@@ -45,7 +46,7 @@ This is designed to be as compact as possible.
 
              <full commit message>
 
-        * 'fuller'
+* 'fuller'
 
          commit <sha1>
          Author: <author>
@@ -57,18 +58,16 @@ This is designed to be as compact as possible.
 
               <full commit message>
 
-
-        * 'email'
+* 'email'
 
          From <sha1> <date>
          From: <author>
          Date: <date & time>
          Subject: [PATCH] <title line>
 
-         full commit message>
-
+         <full commit message>
 
-       * 'raw'
+* 'raw'
 +
 The 'raw' format shows the entire commit exactly as
 stored in the commit object.  Notably, the SHA1s are
@@ -77,19 +76,22 @@ displayed in full, regardless of whether --abbrev or
 true parent commits, without taking grafts nor history
 simplification into account.
 
-       * 'format:'
+* 'format:'
 +
 The 'format:' format allows you to specify which information
 you want to show. It works a little bit like printf format,
 with the notable exception that you get a newline with '%n'
 instead of '\n'.
-
-E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<"'
++
+E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"'
 would show something like this:
-
++
+-------
 The author of fe6e0ee was Junio C Hamano, 23 hours ago
 The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<
 
+--------
++
 The placeholders are:
 
 - '%H': commit hash
@@ -120,11 +122,3 @@ The placeholders are:
 - '%m': left, right or boundary mark
 - '%n': newline
 
-
---encoding[=<encoding>]::
-       The commit objects record the encoding used for the log message
-       in their encoding header; this option can be used to tell the
-       command to re-code the commit log message in the encoding
-       preferred by the user.  For non plumbing commands this
-       defaults to UTF-8.
-
diff --git a/pretty-options.txt b/pretty-options.txt
new file mode 100644 (file)
index 0000000..7d515be
--- /dev/null
@@ -0,0 +1,14 @@
+--pretty[='<format>']::
+
+       Pretty print the contents of the commit logs in a given format,
+       where '<format>' can be one of 'oneline', 'short', 'medium',
+       'full', 'fuller', 'email', 'raw' and 'format:<string>'.
+       When left out the format default to 'medium'.
+
+--encoding[=<encoding>]::
+       The commit objects record the encoding used for the log message
+       in their encoding header; this option can be used to tell the
+       command to re-code the commit log message in the encoding
+       preferred by the user.  For non plumbing commands this
+       defaults to UTF-8.
+