]> git.ipfire.org Git - thirdparty/git.git/commit
doc: move author and committer information to git-commit(1)
authorbrian m. carlson <sandals@crustytoothpaste.net>
Wed, 22 Jan 2020 03:45:39 +0000 (03:45 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 22 Jan 2020 20:27:08 +0000 (12:27 -0800)
commitbc94e5862aed854c77d4f96da9447161ce84a824
tree7c21ed638be798037601ebdc59df0d6098ef3150
parent232378479ee6c66206d47a9be175e3a39682aea6
doc: move author and committer information to git-commit(1)

While at one time it made perfect sense to store information about
configuring author and committer information in the documentation for
git commit-tree, in modern Git that operation is seldom used.  Most
users will use git commit and expect to find comprehensive documentation
about its use in the manual page for that command.

Considering that there is significant confusion about how one is to use
the user.name and user.email variables, let's put as much documentation
as possible into an obvious place where users will be more likely to
find it.

In addition, expand the environment variables section to describe their
use more fully.  Even though we now describe all of the options there
and in the configuration settings documentation, preserve the existing
text in git-commit.txt so that people can easily reason about the
ordering of the various options they can use.  Explain the use of the
author.* and committer.* options as well.

Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/user.txt
Documentation/git-commit-tree.txt
Documentation/git-commit.txt
Documentation/git.txt