From: Marco Roeland Date: Wed, 05 Apr 2006 19:16:08 GMT Subject: [PATCH] git-commit: document --append Message-ID: <20060405191608.GA20572@fiberbit.xs4all.nl> The "--amend" option is used to amend the tip of the current branch. This documentation text was copied straight from the commit that implemented it. Signed-off-by: Marco Roeland --- Documentation/git-commit.txt | 22 +++++++++++++++++++++- 1 files changed, 21 insertions(+), 1 deletions(-) ca7d3b4fdd0cb24b7353da312fb9306531468f54 diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index d04b342..3701cb3 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -9,7 +9,8 @@ SYNOPSIS -------- [verse] 'git-commit' [-a] [-s] [-v] [(-c | -C) | -F | -m ] - [-e] [--author ] [--] [[-i | -o ]...] + [--no-verify] [--amend] [-e] [--author ] + [--] [[-i | -o ]...] DESCRIPTION ----------- @@ -70,6 +71,25 @@ OPTIONS `-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. + +--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 -- 1.3.0.rc2.gca38