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>, Emily Shaffer <emilyshaffer@google.com>
Subject: Re: [PATCH v4 3/5] doc: provide guidance on user.name format
Date: Tue, 21 Jan 2020 14:35:42 -0800	[thread overview]
Message-ID: <xmqq4kwo8mkh.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <20200120173343.4102954-4-sandals@crustytoothpaste.net> (brian m. carlson's message of "Mon, 20 Jan 2020 17:33:41 +0000")

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

> diff --git a/Documentation/config/user.txt b/Documentation/config/user.txt
> index a1f80e823c..f0edb06329 100644
> --- a/Documentation/config/user.txt
> +++ b/Documentation/config/user.txt
> @@ -13,7 +13,12 @@ committer.email::
>  	Also, all of these can be overridden by the `GIT_AUTHOR_NAME`,
>  	`GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_NAME`,
>  	`GIT_COMMITTER_EMAIL` and `EMAIL` environment variables.
> -	See linkgit:git-commit[1] for more information.
> ++
> +Note that the `name` forms of these variables conventionally refer to
> +some form of a personal name.
> +See linkgit:git-commit[1] for more information on these settings and

The environment variables section of git(1) seems to be much more
detailed than what we have in git-commit(1) after the two previous
steps.  I do not mind keeping the reference to git-commit here, but
I think it is also OK to refer to the description in git(1) there,
too.

> diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
> index 7b61c9ba79..13f653989f 100644
> --- a/Documentation/git-commit.txt
> +++ b/Documentation/git-commit.txt
> @@ -475,6 +475,12 @@ variables, if set:
>  
>  (nb "<", ">" and "\n"s are stripped)
>  
> +The author and committer names are by convention some form of a personal name
> +(that is, the name by which other humans refer to you), although Git does not
> +enforce or require any particular form. 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].
> +

Good.

  reply	other threads:[~2020-01-21 22:35 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-01-20 17:33 [PATCH v4 0/6] Documentation for common user misconceptions brian m. carlson
2020-01-20 17:33 ` [PATCH v4 1/5] doc: move author and committer information to git-commit(1) brian m. carlson
2020-01-20 17:52   ` Jeff King
2020-01-20 19:22     ` brian m. carlson
2020-01-21 22:24     ` Junio C Hamano
2020-01-21 22:23   ` Junio C Hamano
2020-01-20 17:33 ` [PATCH v4 2/5] docs: expand on possible and recommended user config options brian m. carlson
2020-01-20 17:33 ` [PATCH v4 3/5] doc: provide guidance on user.name format brian m. carlson
2020-01-21 22:35   ` Junio C Hamano [this message]
2020-01-20 17:33 ` [PATCH v4 4/5] doc: dissuade users from trying to ignore tracked files brian m. carlson
2020-01-20 17:54   ` Jeff King
2020-01-20 17:33 ` [PATCH v4 5/5] docs: mention when increasing http.postBuffer is valuable brian m. carlson
2020-01-20 17:55 ` [PATCH v4 0/6] Documentation for common user misconceptions Jeff King

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=xmqq4kwo8mkh.fsf@gitster-ct.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=emilyshaffer@google.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).