From 813f6025a5094bc27df879eb0152441c4157c47e Mon Sep 17 00:00:00 2001 From: "brian m. carlson" Date: Wed, 22 Jan 2020 03:45:40 +0000 Subject: 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 Signed-off-by: Junio C Hamano 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[] -- cgit v0.10.2-6-g49f6