diff options
| author |  Carlos Martín Nieto <cmn@elego.de> | 2013-04-03 15:07:21 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2013-04-05 07:40:39 -0700 |
| commit | aa7b8c657e407a10cbee728264ec48be16ea4e3d (patch) | |
| tree | 8e53f125328732bd50dde8a8257b0b214b4839f1 | |
| parent | Git 1.8.0.3 (diff) | |
| download | tgif-aa7b8c657e407a10cbee728264ec48be16ea4e3d.tar.xz | |
Documentation/git-commit: reword the --amend explanation
The explanation for 'git commit --amend' talks about preparing a tree
object, which shouldn't be how user-facing documentation talks about
commit.
Reword it to say it works as usual, but replaces the current commit.
Signed-off-by: Carlos Martín Nieto <cmn@elego.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/git-commit.txt | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 19cbb9098f..61266d802f 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -190,14 +190,15 @@ OPTIONS 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: |