X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=git-commit.html;h=ff315aaa2491ba92d895a3bed6144fed84681477;hb=6112cadb5b8a815a65e9924344a663ee16c6723f;hp=01c69600dcc8fef041bd5afac0bff7ed9b49ef6d;hpb=74e8a2d5f3bf4da5598f5a78350efadaddb810b8;p=git.git

diff --git a/git-commit.html b/git-commit.html
index 01c69600..ff315aaa 100644
--- a/git-commit.html
+++ b/git-commit.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 7.0.1" />
+<meta name="generator" content="AsciiDoc 7.0.2" />
 <style type="text/css">
 /* Debug borders */
 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
@@ -274,7 +274,8 @@ git-commit(1) Manual Page
 <div class="sectionbody">
 <div class="verseblock">
 <div class="content"><em>git-commit</em> [-a] [-s] [-v] [(-c | -C) &lt;commit&gt; | -F &lt;file&gt; | -m &lt;msg&gt;]
-           [-e] [--] &lt;file&gt;&#8230;</div></div>
+           [--no-verify] [--amend] [-e] [--author &lt;author&gt;]
+           [--] [[-i | -o ]&lt;file&gt;&#8230;]</div></div>
 </div>
 <h2>DESCRIPTION</h2>
 <div class="sectionbody">
@@ -282,6 +283,8 @@ git-commit(1) Manual Page
 <em>-a</em> is specified, and makes a commit object.  The command
 VISUAL and EDITOR environment variables to edit the commit log
 message.</p>
+<p>Several environment variable are used during commits.  They are
+documented in <a href="git-commit-tree.html">git-commit-tree(1)</a>.</p>
 <p>This command can run <tt>commit-msg</tt>, <tt>pre-commit</tt>, and
 <tt>post-commit</tt> hooks.  See <a href="hooks.html">hooks</a> for more
 information.</p>
@@ -296,7 +299,7 @@ information.</p>
 <p>
         Update all paths in the index file.  This flag notices
         files that have been modified and deleted, but new files
-        you have not told about git are not affected.
+        you have not told git about are not affected.
 </p>
 </dd>
 <dt>
@@ -321,6 +324,15 @@ information.</p>
 </p>
 </dd>
 <dt>
+--author &lt;author&gt;
+</dt>
+<dd>
+<p>
+        Override the author name used in the commit.  Use
+        <tt>A U Thor &lt;author@example.com&gt;</tt> format.
+</p>
+</dd>
+<dt>
 -m &lt;msg&gt;
 </dt>
 <dd>
@@ -369,6 +381,52 @@ information.</p>
 </p>
 </dd>
 <dt>
+--amend
+</dt>
+<dd>
+<p>
+        Used to amend the tip of the current branch. Prepare the tree
+        object you would want to replace the latest commit as usual
+        (this includes the usual -i/-o and explicit paths), and the
+        commit log editor is seeded with the commit message from the
+        tip of the current branch. The commit you create replaces the
+        current tip &#8212; if it was a merge, it will have the parents of
+        the current tip as parents &#8212; so the current top commit is
+        discarded.
+</p>
+<p>It is a rough equivalent for:</p>
+<div class="listingblock">
+<div class="content">
+<pre><tt>        $ git reset --soft HEAD^
+        $ ... do something else to come up with the right tree ...
+        $ git commit -c ORIG_HEAD
+</tt></pre>
+</div></div>
+<p>but can be used to amend a merge commit.</p>
+</dd>
+<dt>
+-i|--include
+</dt>
+<dd>
+<p>
+        Instead of committing only the files specified on the
+        command line, update them in the index file and then
+        commit the whole index.  This is the traditional
+        behaviour.
+</p>
+</dd>
+<dt>
+-o|--only
+</dt>
+<dd>
+<p>
+        Commit only the files specified on the command line.
+        This format cannot be used during a merge, nor when the
+        index and the latest commit does not match on the
+        specified paths to avoid confusion.
+</p>
+</dd>
+<dt>
 &#8212;
 </dt>
 <dd>
@@ -381,13 +439,63 @@ information.</p>
 </dt>
 <dd>
 <p>
-        Update specified paths in the index file before committing.
+        Files to be committed.  The meaning of these is
+        different between <tt>--include</tt> and <tt>--only</tt>.  Without
+        either, it defaults <tt>--only</tt> semantics.
 </p>
 </dd>
 </dl>
 <p>If you make a commit and then found a mistake immediately after
 that, you can recover from it with <a href="git-reset.html">git-reset(1)</a>.</p>
 </div>
+<h2>Discussion</h2>
+<div class="sectionbody">
+<p><tt>git commit</tt> without _any_ parameter commits the tree structure
+recorded by the current index file.  This is a whole-tree commit
+even the command is invoked from a subdirectory.</p>
+<p><tt>git commit --include paths&#8230;</tt> is equivalent to</p>
+<div class="literalblock">
+<div class="content">
+<pre><tt>git update-index --remove paths...
+git commit</tt></pre>
+</div></div>
+<p>That is, update the specified paths to the index and then commit
+the whole tree.</p>
+<p><tt>git commit paths&#8230;</tt> largely bypasses the index file and
+commits only the changes made to the specified paths.  It has
+however several safety valves to prevent confusion.</p>
+<ol>
+<li>
+<p>
+It refuses to run during a merge (i.e. when
+  <tt>$GIT_DIR/MERGE_HEAD</tt> exists), and reminds trained git users
+  that the traditional semantics now needs -i flag.
+</p>
+</li>
+<li>
+<p>
+It refuses to run if named <tt>paths&#8230;</tt> are different in HEAD
+  and the index (ditto about reminding).  Added paths are OK.
+  This is because an earlier <tt>git diff</tt> (not <tt>git diff HEAD</tt>)
+  would have shown the differences since the last <tt>git
+  update-index paths&#8230;</tt> to the user, and an inexperienced user
+  may mistakenly think that the changes between the index and
+  the HEAD (i.e. earlier changes made before the last <tt>git
+  update-index paths&#8230;</tt> was done) are not being committed.
+</p>
+</li>
+<li>
+<p>
+It reads HEAD commit into a temporary index file, updates the
+  specified <tt>paths&#8230;</tt> and makes a commit.  At the same time,
+  the real index file is also updated with the same <tt>paths&#8230;</tt>.
+</p>
+</li>
+</ol>
+<p><tt>git commit --all</tt> updates the index file with _all_ changes to
+the working tree, and makes a whole-tree commit, regardless of
+which subdirectory the command is invoked in.</p>
+</div>
 <h2>Author</h2>
 <div class="sectionbody">
 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt; and
@@ -399,7 +507,7 @@ Junio C Hamano &lt;junkio@cox.net&gt;</p>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 13-Jan-2006 19:58:26 PDT
+Last updated 05-Apr-2006 23:07:59 UTC
 </div>
 </div>
 </body>
