about summary refs log tree commit diff
path: root/third_party/git/Documentation/config/user.txt
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/git/Documentation/config/user.txt')
-rw-r--r--third_party/git/Documentation/config/user.txt7
1 files changed, 6 insertions, 1 deletions
diff --git a/third_party/git/Documentation/config/user.txt b/third_party/git/Documentation/config/user.txt
index 0557cbbceb81..59aec7c3aed3 100644
--- a/third_party/git/Documentation/config/user.txt
+++ b/third_party/git/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`