summaryrefslogtreecommitdiff
path: root/Documentation/config
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2020-01-30 14:17:11 -0800
committerLibravatar Junio C Hamano <gitster@pobox.com>2020-01-30 14:17:12 -0800
commitc9ccf9d09b3aa179b198774afb720e229b544f45 (patch)
treed5ec899e7e25d070e47982d0cf8244538a0fdd1f /Documentation/config
parentMerge branch 'ss/t6025-modernize' (diff)
parentdoc: provide guidance on user.name format (diff)
downloadtgif-c9ccf9d09b3aa179b198774afb720e229b544f45.tar.xz
Merge branch 'bc/author-committer-doc'
Clarify documentation on committer/author identities. * bc/author-committer-doc: doc: provide guidance on user.name format docs: expand on possible and recommended user config options doc: move author and committer information to git-commit(1)
Diffstat (limited to 'Documentation/config')
-rw-r--r--Documentation/config/user.txt7
1 files changed, 6 insertions, 1 deletions
diff --git a/Documentation/config/user.txt b/Documentation/config/user.txt
index 0557cbbceb..59aec7c3ae 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-tree[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] 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`