From: Carlos Martín Nieto Date: Fri, 05 Apr 2013 08:50:05 GMT Subject: Re: [PATCH] Documentation/git-commit: reword the --amend explanation Message-ID: <1365151805.2478.25.camel@flaca.cmartin.tk> In-Reply-To: <7va9pejkgt.fsf@alter.siamese.dyndns.org> On Thu, 2013-04-04 at 10:04 -0700, Junio C Hamano wrote: > Carlos Martín Nieto writes: > > > 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 > Looks good, yeah. This should stop anybody thinking that they can replace the tip with an arbitrary commit. cmn