summaryrefslogtreecommitdiff
path: root/Documentation/git-commit.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2013-04-12 13:41:47 -0700
committerJunio C Hamano <gitster@pobox.com>2013-04-12 13:41:47 -0700
commit788e98f8c0a09d71bd1ed64a71c941a8d10d91c4 (patch)
treeb43206adee0621c992c65fdd1def5cc428ae114f /Documentation/git-commit.txt
parent23589a90c3673be5c308cbdd62637bd0cdb6c680 (diff)
parentaa7b8c657e407a10cbee728264ec48be16ea4e3d (diff)
downloadgit-788e98f8c0a09d71bd1ed64a71c941a8d10d91c4.tar.gz
Merge branch 'cn/commit-amend-doc' into maint
* cn/commit-amend-doc: Documentation/git-commit: reword the --amend explanation
Diffstat (limited to 'Documentation/git-commit.txt')
-rw-r--r--Documentation/git-commit.txt17
1 files changed, 9 insertions, 8 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 05f8297368..9b1be5581d 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -207,14 +207,15 @@ variable (see linkgit:git-config[1]).
without changing its commit message.
--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.
+ Replace the tip of the current branch by creating a new
+ commit. The recorded tree is prepared as usual (including
+ the effect of the `-i` and `-o` options and explicit
+ pathspec), and the message from the original commit is used
+ as the starting point, instead of an empty message, when no
+ other message is specified from the command line via options
+ such as `-m`, `-F`, `-c`, etc. The new commit has the same
+ parents and author as the current one (the `--reset-author`
+ option can countermand this).
+
--
It is a rough equivalent for: