git-blame(1): mention options in the synopsis and advertise pickaxe

[git.git] / Documentation / git-commit.txt

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 214ed235c554de89edc4f614072b50c6f0724ded..517a86b238a91a1c853b5fbe331a5cc984e95878 100644 (file)
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -9,14 +9,19 @@ SYNOPSIS
 --------
 [verse]
 'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>]
 --------
 [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
 -----------
 Updates the index file for given paths, or all modified files if
 
 DESCRIPTION
 -----------
 Updates the index file for given paths, or all modified files if

-'-a' is specified, and makes a commit object.  The command
-VISUAL and EDITOR environment variables to edit the commit log
-message.
+'-a' is specified, and makes a commit object.  The command specified
+by either the VISUAL or EDITOR environment variables are used 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
 
 This command can run `commit-msg`, `pre-commit`, and
 `post-commit` hooks.  See link:hooks.html[hooks] for more


@@ -67,11 +72,33 @@ OPTIONS
        commit log message unmodified.  This option lets you
        further edit the message taken from these sources.
 
        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
 -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.
 
 -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.
 
        index and the latest commit does not match on the
        specified paths to avoid confusion.
 

---::
+\--::

        Do not interpret any more arguments as options.
 
 <file>...::
        Do not interpret any more arguments as options.
 
 <file>...::