Re: [PATCH] Documentation/git-commit: reword the --amend explanation
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Apr 4, 2013, 17:04 UTC
- Message-ID
- <7va9pejkgt.fsf@alter.siamese.dyndns.org>
- In-Reply-To
- <1365094159.30466.60.camel@centaur.cmartin.tk>
Carlos Martín Nieto <cmn@elego.de> writes:
Show 10 quoted lines
> On Wed, 2013-04-03 at 23:25 +0100, Philip Oakley wrote: > >> + Replace the tip of the current branch with a fresh commit. >> [or updated commit, or new commit, or ...] > > Ack, we should lead with the goal, I'd go for the > > "Replace the tip of the current branch with a new commit" > > wording.
We would want to be careful to make sure that the reader understands that the "new commit" is created by running this command (i.e. it is not like "git branch -f $current_branch $new_commit"), but other than that, sounds sensible.
Perhaps like this?
Documentation/git-commit.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index bc919ac..61266d8 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -190,8 +190,8 @@ OPTIONS without changing its commit message. --amend:: - Create a new commit and replace the tip of the current - branch. The recorded tree is prepared as usual (including + 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