Autogenerated HTML docs for v1.3.0-rc2-gae5d

[git.git] / git-commit.txt

diff --git a/git-commit.txt b/git-commit.txt
index d04b342..2af472a 100644 (file)
--- a/git-commit.txt
+++ b/git-commit.txt
@@ -9,7 +9,8 @@ SYNOPSIS
 --------
 [verse]
 'git-commit' [-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>...]
 
 DESCRIPTION
 -----------
@@ -71,6 +72,27 @@ OPTIONS
        commit log message unmodified.  This option lets you
        further edit the message taken from these sources.
 
+--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:
++
+------------
+       $ git reset --soft HEAD^
+       $ ... do something else to come up with the right tree ...
+       $ git commit -c ORIG_HEAD
+------------
++
+but can be used to amend a merge commit.
+
 -i|--include::
        Instead of committing only the files specified on the
        command line, update them in the index file and then