From: Jeff King <peff@peff.net>
To: "brian m. carlson" <sandals@crustytoothpaste.net>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH v2 1/3] doc: provide guidance on user.name format
Date: Thu, 17 Oct 2019 01:40:52 -0400 [thread overview]
Message-ID: <20191017054051.GA10253@sigill.intra.peff.net> (raw)
In-Reply-To: <20191017005330.9021-2-sandals@crustytoothpaste.net>
On Thu, Oct 17, 2019 at 12:53:28AM +0000, brian m. carlson wrote:
> It's a frequent misconception that the user.name variable controls
> authentication in some way, and as a result, beginning users frequently
> attempt to change it when they're having authentication troubles.
> Document that the convention is that this variable represents some form
> of a human's personal name, although that is not required. In addition,
> address concerns about whether Unicode is supported.
>
> Use the term "personal name" as this is likely to draw the intended
> contrast, be applicable across cultures which may have different naming
> conventions, and be easily understandable to people who do not speak
> English as their first language. Indicate that "some form" is
> conventionally used, as people may use a nickname or preferred name
> instead of a full legal name.
>
> Point users who may be confused about authentication to an appropriate
> configuration option instead.
I think this is a good distinction to draw, but...
> Documentation/git-commit-tree.txt | 6 ++++++
> 1 file changed, 6 insertions(+)
...I was surprised to see it here, where I think most users wouldn't
find it. Would it make sense in git-commit(1), or in the description of
the user.name config?
-Peff
next prev parent reply other threads:[~2019-10-17 5:40 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-17 0:53 [PATCH v2 0/3] Documentation for common user misconceptions brian m. carlson
2019-10-17 0:53 ` [PATCH v2 1/3] doc: provide guidance on user.name format brian m. carlson
2019-10-17 5:40 ` Jeff King [this message]
2019-10-17 7:39 ` Junio C Hamano
2019-10-17 22:20 ` brian m. carlson
2019-10-18 5:37 ` Jeff King
2019-10-17 0:53 ` [PATCH v2 2/3] doc: dissuade users from trying to ignore tracked files brian m. carlson
2019-10-17 5:44 ` Jeff King
2019-10-17 0:53 ` [PATCH v2 3/3] docs: mention when increasing http.postBuffer is valuable brian m. carlson
2019-10-17 5:52 ` 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=20191017054051.GA10253@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--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).