git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 1/3] doc: provide guidance on user.name format

From
Jeff King <peff@peff.net>
Date
Oct 17, 2019, 05:40 UTC
Message-ID
<20191017054051.GA10253@sigill.intra.peff.net>
In-Reply-To
<20191017005330.9021-2-sandals@crustytoothpaste.net>
On Thu, Oct 17, 2019 at 12:53:28AM +0000, brian m. carlson wrote:
Show 16 quoted lines
> 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
Previous: brian m. carlsonNext: Junio C Hamano
Message 7 of 10 in “Documentation for common user misconceptions”
  1. 0/3 Documentation for common user misconceptionsbrian m. carlson, Oct 17, 2019
  2. 3/3 docs: mention when increasing http.postBuffer is valuablebrian m. carlson, Oct 17, 2019
  3. Jeff KingOct 17, 2019
  4. 2/3 doc: dissuade users from trying to ignore tracked filesbrian m. carlson, Oct 17, 2019
  5. Jeff KingOct 17, 2019
  6. 1/3 doc: provide guidance on user.name formatbrian m. carlson, Oct 17, 2019
  7. Jeff KingOct 17, 2019
  8. Junio C HamanoOct 17, 2019
  9. brian m. carlsonOct 17, 2019
  10. Jeff KingOct 18, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.