Skip to content

Commit

Permalink
Merge branch 'cn/commit-amend-doc' into maint
Browse files Browse the repository at this point in the history
* cn/commit-amend-doc:
  Documentation/git-commit: reword the --amend explanation
  • Loading branch information
Junio C Hamano committed Apr 12, 2013
2 parents 23589a9 + aa7b8c6 commit 788e98f
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions Documentation/git-commit.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 788e98f

Please sign in to comment.