summaryrefslogtreecommitdiff
path: root/Documentation/git-commit.txt
diff options
context:
space:
mode:
authorbrian m. carlson <sandals@crustytoothpaste.net>2020-01-22 03:45:40 (GMT)
committerJunio C Hamano <gitster@pobox.com>2020-01-22 20:27:08 (GMT)
commit813f6025a5094bc27df879eb0152441c4157c47e (patch)
tree4ba1c8e05d15e6c9d52eff9ae23ee3b9b245ab04 /Documentation/git-commit.txt
parentbc94e5862aed854c77d4f96da9447161ce84a824 (diff)
downloadgit-813f6025a5094bc27df879eb0152441c4157c47e.zip
git-813f6025a5094bc27df879eb0152441c4157c47e.tar.gz
git-813f6025a5094bc27df879eb0152441c4157c47e.tar.bz2
docs: expand on possible and recommended user config options
In the section on setting author and committer information, we omit the author.* and committer.* variables, so mention them for completeness. In addition, guide users to the typical case: simply setting user.name and user.email, which are recommended if one does not need complex configuration. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-commit.txt')
-rw-r--r--Documentation/git-commit.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 30c30cc..7b61c9b 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -482,6 +482,13 @@ system user name and the hostname used for outgoing mail (taken
from `/etc/mailname` and falling back to the fully qualified hostname when
that file does not exist).
+The `author.name` and `committer.name` and their corresponding email options
+override `user.name` and `user.email` if set and are overridden themselves by
+the environment variables.
+
+The typical usage is to set just the `user.name` and `user.email` variables;
+the other options are provided for more complex use cases.
+
:git-commit: 1
include::date-formats.txt[]