Autogenerated man pages for v1.3.2-g8611
[git.git] / man1 / git-commit.1
index 098c3ef..7faec23 100755 (executable)
@@ -24,7 +24,8 @@ git-commit \- Record your changes
 
 .nf
 \fIgit\-commit\fR [\-a] [\-s] [\-v] [(\-c | \-C) <commit> | \-F <file> | \-m <msg>]
-           [\-e] [\-\-author <author>] [\-\-] [[\-i | \-o ]<file>...]
+           [\-\-no\-verify] [\-\-amend] [\-e] [\-\-author <author>]
+           [\-\-] [[\-i | \-o ]<file>...]
 .fi
 
 .SH "DESCRIPTION"
@@ -77,6 +78,21 @@ The opposite of \-\-verify\&.
 The message taken from file with \-F, command line with \-m, and from file with \-C are usually used as the commit log message unmodified\&. This option lets you further edit the message taken from these sources\&.
 
 .TP
+\-\-amend
+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 -- if it was a merge, it will have the parents of the current tip as parents -- so the current top commit is discarded\&.
+
+It is a rough equivalent for:
+
+
+.nf
+        $ git reset \-\-soft HEAD^
+        $ \&.\&.\&. do something else to come up with the right tree \&.\&.\&.
+        $ git commit \-c ORIG_HEAD
+
+.fi
+but can be used to amend a merge commit\&.
+
+.TP
 \-i|\-\-include
 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\&.
 
@@ -85,7 +101,7 @@ Instead of committing only the files specified on the command line, update them
 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\&.
 
 .TP
---
+\-\-
 Do not interpret any more arguments as options\&.
 
 .TP