git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "brian m. carlson" <sandals@crustytoothpaste.net>
Cc: <git@vger.kernel.org>
Subject: Re: [PATCH] doc: provide guidance on user.name format
Date: Sun, 15 Sep 2019 15:18:07 -0700	[thread overview]
Message-ID: <xmqqtv9db3vk.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <20190914210219.753136-1-sandals@crustytoothpaste.net> (brian m. carlson's message of "Sat, 14 Sep 2019 21:02:19 +0000")

"brian m. carlson" <sandals@crustytoothpaste.net> writes:

> Users may or may not read the documentation, but at least we've done our
> best at providing them helpful information should they choose to do so.

Good.

>  Documentation/git-commit-tree.txt | 6 ++++++
>  1 file changed, 6 insertions(+)
>
> diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt
> index 4b90b9c12a..34a8496b0e 100644
> --- a/Documentation/git-commit-tree.txt
> +++ b/Documentation/git-commit-tree.txt
> @@ -92,6 +92,12 @@ if set:
>  
>  (nb "<", ">" and "\n"s are stripped)
>  
> +The author and committer names are by convention some form of a personal name,
> +as opposed to a username, although Git does not enforce or require any
> +particular form.

I have a lot of trouble with 'username' in the context of this
paragraph.

After all, you are describing the name appropriate to be set as the
value of the user.name configuration, and you are trying to stress
that the name used there is different from and has nothing to do
with the name machines use to identify the user.  In the paragraph
that follows this new paragraph, there is a reference to "system
user name", which is still not great but probably better than
"username" above.  Perhaps there is a term that is distinct enough
from "user name" that is commonly used I am forgetting?  I am almost
tempted to say "user id", but there must be even better phrases.  I
dunno.

> Arbitrary Unicode may be used, subject to the constraints
> +listed above. This name has no effect on authentication; for that, see the
> +`credential.username` variable in linkgit::git-config[1].
> +
>  In case (some of) these environment variables are not set, the information
>  is taken from the configuration items user.name and user.email, or, if not
>  present, the environment variable EMAIL, or, if that is not set,

Thanks.


  reply	other threads:[~2019-09-15 22:18 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-09-14 21:02 [PATCH] doc: provide guidance on user.name format brian m. carlson
2019-09-15 22:18 ` Junio C Hamano [this message]
2019-09-15 22:57   ` brian m. carlson

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

  List information: http://vger.kernel.org/majordomo-info.html

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

  git send-email \
    --in-reply-to=xmqqtv9db3vk.fsf@gitster-ct.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=sandals@crustytoothpaste.net \
    /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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).