diff options
| author | Junio C Hamano <junio@hera.kernel.org> | 2006-02-07 08:04:39 +0000 |
|---|---|---|
| committer | Junio C Hamano <junio@hera.kernel.org> | 2006-02-07 08:04:39 +0000 |
| commit | 40f2f8dd79c1622a7986e2ff2faa15c72860c79f (patch) | |
| tree | 8caad58489c0d80a936d8185c85f45f19cf0703e /git-commit.html | |
| parent | 5e461f9764f680aa78a7c16f1c9182dc36961662 (diff) | |
| download | git-htmldocs-40f2f8dd79c1622a7986e2ff2faa15c72860c79f.tar.gz | |
Autogenerated HTML docs for v1.1.6-g5a79
Diffstat (limited to 'git-commit.html')
| -rw-r--r-- | git-commit.html | 81 |
1 files changed, 76 insertions, 5 deletions
diff --git a/git-commit.html b/git-commit.html index 44e85edcd..f391cfff7 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 {
@@ -273,8 +273,8 @@ git-commit(1) Manual Page <h2>SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<div class="content"><em>git-commit</em> [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>]
- [-e] [--] <file>…</div></div>
+<div class="content"><em>git-commit</em> [-a] [-i] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>]
+ [-e] [--author <author>] [--] <file>…</div></div>
</div>
<h2>DESCRIPTION</h2>
<div class="sectionbody">
@@ -321,6 +321,15 @@ information.</p> </p>
</dd>
<dt>
+--author <author>
+</dt>
+<dd>
+<p>
+ Override the author name used in the commit. Use
+ <tt>A U Thor <author@example.com></tt> format.
+</p>
+</dd>
+<dt>
-m <msg>
</dt>
<dd>
@@ -369,6 +378,17 @@ information.</p> </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>
—
</dt>
<dd>
@@ -381,13 +401,64 @@ information.</p> </dt>
<dd>
<p>
- Update specified paths in the index file before committing.
+ 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>
</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…</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…</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…</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…</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…</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…</tt> and makes a commit. At the same time,
+ the real index file is also updated with the same <tt>paths…</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 <torvalds@osdl.org> and
@@ -399,7 +470,7 @@ Junio C Hamano <junkio@cox.net></p> </div>
<div id="footer">
<div id="footer-text">
-Last updated 21-Jan-2006 23:50:16 PDT
+Last updated 07-Feb-2006 08:04:29 UTC
</div>
</div>
</body>
|