doc: provide guidance on user.name format
commit69e104d70e29060742c75ccdcb6653e23c65f3c3
authorbrian m. carlson <sandals@crustytoothpaste.net>
Wed, 22 Jan 2020 03:45:41 +0000 (22 03:45 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 22 Jan 2020 20:27:08 +0000 (22 12:27 -0800)
tree9fcd65dcd5b3a1a56c8c545c306a6fa86eb03483
parent813f6025a5094bc27df879eb0152441c4157c47e
doc: provide guidance on user.name format

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.  Provide a shortened form of this
information in the configuration option description.

Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/user.txt
Documentation/git-commit.txt