X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-commit.txt;h=0fe66f2d0c84003d285fed426181998063e86b96;hb=HEAD;hp=214ed235c554de89edc4f614072b50c6f0724ded;hpb=45dcab31ee89ace3403f63381366499ce78cef42;p=git.git

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 214ed235..0fe66f2d 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/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
 -----------
@@ -18,6 +19,10 @@ Updates the index file for given paths, or all modified files if
 VISUAL and EDITOR environment variables to edit the commit log
 message.
 
+Several environment variable are used during commits.  They are
+documented in gitlink:git-commit-tree[1].
+
+
 This command can run `commit-msg`, `pre-commit`, and
 `post-commit` hooks.  See link:hooks.html[hooks] for more
 information.
@@ -67,11 +72,33 @@ 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
 	commit the whole index.  This is the traditional
-	behaviour.
+	behavior.
 
 -o|--only::
 	Commit only the files specified on the command line.
@@ -79,7 +106,7 @@ OPTIONS
 	index and the latest commit does not match on the
 	specified paths to avoid confusion.
 
---::
+\--::
 	Do not interpret any more arguments as options.
 
 <file>...::