git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Eric Sunshine <sunshine@sunshineco.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Git List <git@vger.kernel.org>,
	Andreas Schwab <schwab@linux-m68k.org>,
	Alvaro Aleman <aaleman@redhat.com>
Subject: Re: [PATCH] ident: say whose identity is missing when giving user.name hint
Date: Fri, 21 Aug 2020 16:52:33 -0400	[thread overview]
Message-ID: <CAPig+cR12i8KQjiWYm8DGuAc9BfJqanmNBZcZfwHGsrt2hW3Dw@mail.gmail.com> (raw)
In-Reply-To: <xmqq5z9b91o3.fsf_-_@gitster.c.googlers.com>

On Fri, Aug 21, 2020 at 4:36 PM Junio C Hamano <gitster@pobox.com> wrote:
> When the author or the committer identity is missing when required,
> "git" errors out with a message that suggests to set these
> configuration variables at the per-user level as the easiest way
> forward.  This message is given to a brand-new user, whose
> ~/.gitconfig hasn't been configured for user.name and user.email,
> who runs "git commit --author=...", too, but such a user may find it
> confusing ("why?  I just gave you a name and e-mail").
>
> State whose identity is missing as the reason why we are erroring
> out, when we give the hint, to help reduce the confusion.

I had trouble following the first paragraph due to the run-on nature
of the second sentence. Perhaps the entire message could be rewritten
something like this:

    If `user.name` and `user.email` have not been configured and the
    user invokes:

        git commit --author=...

    without without specifying `--committer=`, then Git errors out
    with a message asking the user to configure `user.name` and
    `user.email` but doesn't tell the user which attribution was
    missing. This can be confusing for a user new to Git who isn't
    aware of the distinction between user, author, and committer.
    Give such users a bit more help by extending the error message to
    also say which attribution is expected.

  reply	other threads:[~2020-08-21 20:52 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-21 16:15 --author arg on commit only works if there is an email configured already Alvaro Aleman
2020-08-21 18:28 ` Andreas Schwab
2020-08-21 18:46   ` Junio C Hamano
2020-08-21 19:55     ` Alvaro Aleman
2020-08-21 20:36       ` [PATCH] ident: say whose identity is missing when giving user.name hint Junio C Hamano
2020-08-21 20:52         ` Eric Sunshine [this message]
2020-08-21 21:13           ` Junio C Hamano
2020-08-21 21:31             ` Alvaro Aleman
2020-08-21 21:37               ` Eric Sunshine
2020-08-21 22:35                 ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAPig+cR12i8KQjiWYm8DGuAc9BfJqanmNBZcZfwHGsrt2hW3Dw@mail.gmail.com \
    --to=sunshine@sunshineco.com \
    --cc=aaleman@redhat.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=schwab@linux-m68k.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).