mirror of
https://github.com/git/git.git
synced 2024-05-20 09:56:10 +02:00
69e104d70e
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>
39 lines
1.6 KiB
Plaintext
39 lines
1.6 KiB
Plaintext
user.name::
|
|
user.email::
|
|
author.name::
|
|
author.email::
|
|
committer.name::
|
|
committer.email::
|
|
The `user.name` and `user.email` variables determine what ends
|
|
up in the `author` and `committer` field of commit
|
|
objects.
|
|
If you need the `author` or `committer` to be different, the
|
|
`author.name`, `author.email`, `committer.name` or
|
|
`committer.email` variables can be set.
|
|
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.
|
|
+
|
|
Note that the `name` forms of these variables conventionally refer to
|
|
some form of a personal name. See linkgit:git-commit[1] and the
|
|
environment variables section of linkgit:git[1] for more information on
|
|
these settings and the `credential.username` option if you're looking
|
|
for authentication credentials instead.
|
|
|
|
user.useConfigOnly::
|
|
Instruct Git to avoid trying to guess defaults for `user.email`
|
|
and `user.name`, and instead retrieve the values only from the
|
|
configuration. For example, if you have multiple email addresses
|
|
and would like to use a different one for each repository, then
|
|
with this configuration option set to `true` in the global config
|
|
along with a name, Git will prompt you to set up an email before
|
|
making new commits in a newly cloned repository.
|
|
Defaults to `false`.
|
|
|
|
user.signingKey::
|
|
If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
|
|
key you want it to automatically when creating a signed tag or
|
|
commit, you can override the default selection with this variable.
|
|
This option is passed unchanged to gpg's --local-user parameter,
|
|
so you may specify a key using any method that gpg supports.
|