Re: [PATCH v4 3/5] doc: provide guidance on user.name format
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Jan 21, 2020, 22:35 UTC
- Message-ID
- <xmqq4kwo8mkh.fsf@gitster-ct.c.googlers.com>
- In-Reply-To
- <20200120173343.4102954-4-sandals@crustytoothpaste.net>
"brian m. carlson" <sandals@crustytoothpaste.net> writes:
Show 13 quoted lines
> 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.
Show 14 quoted lines
> 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.