Skip to content

Commit 813f602

Browse files
bk2204gitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent bc94e58 commit 813f602

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

Documentation/git-commit.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -482,6 +482,13 @@ system user name and the hostname used for outgoing mail (taken
482482
from `/etc/mailname` and falling back to the fully qualified hostname when
483483
that file does not exist).
484484

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+
485492
:git-commit: 1
486493
include::date-formats.txt[]
487494

0 commit comments

Comments
 (0)