patchcommit: suggest --amend --reset-author to fix commiter identity

The advantage of this command is that it is cut-and-paste ready, while using --author='...' requires the user to type his name and email a second time.

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
---
 builtin/commit.c |    6 +++++-
 1 files changed, 5 insertions(+), 1 deletions(-)

Matthieu Moy wrote:

This message gets used when the author was set from gecos because not available in the configuration. Do you perhaps mean:

	If the identity used for this commit is wrong, you can fix it with:

	    git commit --amend --author='Your Name <you@example.com>'
	    git commit --amend --author='Your Name <you@example.com>'

	or

	    cat <<EOF >>~/.gitconfig
	    [user]
	      name = Your Name
	      email = you@example.com
	    EOF
	    git commit --amend --reset-author

?

Jonathan Nieder <jrnieder@gmail.com> writes:

The complete message says:

"Your name and email address were configured automatically based\n" "on your username and hostname. Please check that they are accurate.\n" "You can suppress this message by setting them explicitly:\n" "\n" " git config --global user.name \"Your Name\"\n" " git config --global user.email you@example.com\n" "\n" "If the identity used for this commit is wrong, you can fix it with:\n" "\n" " git commit --amend --author='Your Name <you@example.com>'\n" "\n" "or\n" "\n" " git commit --amend --reset-author\n";

So, the natural thing to do is

git config --global user.name "me" git config --global user.email "my.email@bla.com" git commit --amend --reset-author

and it's not necessary to use the longer

git config --global user.name "me" git config --global user.email "my.email@bla.com" git commit --amend --author='me <my.email@bla.com>'

Matthieu Moy wrote:

Sloppy reading on my part.  So the original text explains:

	how to configure your identity globally
	how to change the identity for a single commit

Maybe:

	If the identity used for this commit is wrong, you can fix it:

	    git commit --amend --author='Patch Submitter <author@example.com>'

	To just use your newly configured identity:

	    git commit --amend --reset-author

(modulo wording). The idea being to make it clear to the user why we are telling two ways to do the same thing.

Sorry for the nonsense. Jonathan

Matthieu Moy <Matthieu.Moy@imag.fr> writes:

I don't think making the "cheat-sheet" insn longer by offering more choices is a good idea. These are messages for lazy and busy people.

Wouldn't it work better to just get rid of the longer form and say something like:

    ... here is how to tell your name to git (existing message) ...

    After doing the above, run

    	git commit --amend --reset-author

    to fix the identity used for this commit.

Junio C Hamano <gitster@pobox.com> writes:

The reason I kept both forms was that the message is designed to be seen once (or once for each new machine one works on), and the most scary it is, the most efficient ;-).

I'm fine with that proposal too. I'll resend with that if no one objects. Probalby rewording it to

After doing this, you can fix the identity used for this commit with:

  git commit --amend --reset-author

would make it even concisier (no break of the sentence with a command).

On Sat, Jan 08, 2011 at 11:56:00AM +0100, Matthieu Moy wrote:

Hmm. When I originally wrote that message, I specifically avoided using --reset-author because I figured people would want to most immediately fix the broken commit, and then maybe would not be too lazy to fix things for the future. But that was just a hunch, and I don't feel strongly about it.

I was also afraid of people blindly running the fixup command without doing the configuration specified in the commands above. However, I think as long as the text makes it clear that one depends on the other, it should be OK. So something like:

looks fine to me.

-Peff

Since the message advise to fix the configuration first, the advantage of this command is that it is cut-and-paste ready, while using --author='...' requires the user to type his name and email a second time.

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
---
 builtin/commit.c |    6 +++++-
 1 files changed, 5 insertions(+), 1 deletions(-)

Since the message advise to fix the configuration first, the advantage of this command is that it is cut-and-paste ready, while using --author='...' requires the user to type his name and email a second time.

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
---
Sorry, I did a resend the other day, which was plain wrong (I had the
changes in my tree, but sent before commit--amend-ing).

This one should be OK.

 builtin/commit.c |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

On Wed, Jan 12, 2011 at 07:29:14PM +0100, Matthieu Moy wrote:

Yeah, this one looks good.

Acked-by: Jeff King <peff@peff.net>

-Peff