Autogenerated HTML docs for v1.4.0-rc1
[git.git] / git-commit.html
index f391cff..abf9e09 100644 (file)
@@ -273,8 +273,9 @@ git-commit(1) Manual Page
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
 <div class="verseblock">\r
-<div class="content"><em>git-commit</em> [-a] [-i] [-s] [-v] [(-c | -C) &lt;commit&gt; | -F &lt;file&gt; | -m &lt;msg&gt;]\r
-           [-e] [--author &lt;author&gt;] [--] &lt;file&gt;&#8230;</div></div>\r
+<div class="content"><em>git-commit</em> [-a] [-s] [-v] [(-c | -C) &lt;commit&gt; | -F &lt;file&gt; | -m &lt;msg&gt;]\r
+           [--no-verify] [--amend] [-e] [--author &lt;author&gt;]\r
+           [--] [[-i | -o ]&lt;file&gt;&#8230;]</div></div>\r
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
@@ -282,6 +283,8 @@ git-commit(1) Manual Page
 <em>-a</em> is specified, and makes a commit object.  The command\r
 VISUAL and EDITOR environment variables to edit the commit log\r
 message.</p>\r
+<p>Several environment variable are used during commits.  They are\r
+documented in <a href="git-commit-tree.html">git-commit-tree(1)</a>.</p>\r
 <p>This command can run <tt>commit-msg</tt>, <tt>pre-commit</tt>, and\r
 <tt>post-commit</tt> hooks.  See <a href="hooks.html">hooks</a> for more\r
 information.</p>\r
@@ -378,6 +381,30 @@ information.</p>
 </p>\r
 </dd>\r
 <dt>\r
+--amend\r
+</dt>\r
+<dd>\r
+<p>\r
+        Used to amend the tip of the current branch. Prepare the tree\r
+        object you would want to replace the latest commit as usual\r
+        (this includes the usual -i/-o and explicit paths), and the\r
+        commit log editor is seeded with the commit message from the\r
+        tip of the current branch. The commit you create replaces the\r
+        current tip &#8212; if it was a merge, it will have the parents of\r
+        the current tip as parents &#8212; so the current top commit is\r
+        discarded.\r
+</p>\r
+<p>It is a rough equivalent for:</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>        $ git reset --soft HEAD^\r
+        $ ... do something else to come up with the right tree ...\r
+        $ git commit -c ORIG_HEAD\r
+</tt></pre>\r
+</div></div>\r
+<p>but can be used to amend a merge commit.</p>\r
+</dd>\r
+<dt>\r
 -i|--include\r
 </dt>\r
 <dd>\r
@@ -385,11 +412,22 @@ information.</p>
         Instead of committing only the files specified on the\r
         command line, update them in the index file and then\r
         commit the whole index.  This is the traditional\r
-        behaviour.\r
+        behavior.\r
+</p>\r
+</dd>\r
+<dt>\r
+-o|--only\r
+</dt>\r
+<dd>\r
+<p>\r
+        Commit only the files specified on the command line.\r
+        This format cannot be used during a merge, nor when the\r
+        index and the latest commit does not match on the\r
+        specified paths to avoid confusion.\r
 </p>\r
 </dd>\r
 <dt>\r
-&#8212;\r
+--\r
 </dt>\r
 <dd>\r
 <p>\r
@@ -401,10 +439,9 @@ information.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        Commit only the files specified on the command line.\r
-        This format cannot be used during a merge, nor when the\r
-        index and the latest commit does not match on the\r
-        specified paths to avoid confusion.\r
+        Files to be committed.  The meaning of these is\r
+        different between <tt>--include</tt> and <tt>--only</tt>.  Without\r
+        either, it defaults <tt>--only</tt> semantics.\r
 </p>\r
 </dd>\r
 </dl>\r
@@ -470,7 +507,7 @@ Junio C Hamano &lt;junkio@cox.net&gt;</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 07-Feb-2006 08:04:29 UTC\r
+Last updated 04-Jun-2006 07:24:22 UTC\r
 </div>\r
 </div>\r
 </body>\r