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>
brian m. carlson committed
Jan 22, 2020 at 03:45 UTC
813f6025a5094bc27df879eb0152441c4157c47e
1 file changed
+7
Documentation/git-commit.txt
+7
@@ -482,6 +482,13 @@ system user name and the hostname used for outgoing mail (taken
482
from `/etc/mailname` and falling back to the fully qualified hostname when
483
that file does not exist).
484
485
+The `author.name` and `committer.name` and their corresponding email options
486
+override `user.name` and `user.email` if set and are overridden themselves by
487
+the environment variables.
488
+
489
+The typical usage is to set just the `user.name` and `user.email` variables;
490
+the other options are provided for more complex use cases.
491
+
492
:git-commit: 1
493
include::date-formats.txt[]
494