summaryrefslogtreecommitdiff
path: root/Documentation/config
diff options
context:
space:
mode:
authorbrian m. carlson <sandals@crustytoothpaste.net>2020-01-22 03:45:39 (GMT)
committerJunio C Hamano <gitster@pobox.com>2020-01-22 20:27:08 (GMT)
commitbc94e5862aed854c77d4f96da9447161ce84a824 (patch)
tree7c21ed638be798037601ebdc59df0d6098ef3150 /Documentation/config
parent232378479ee6c66206d47a9be175e3a39682aea6 (diff)
downloadgit-bc94e5862aed854c77d4f96da9447161ce84a824.zip
git-bc94e5862aed854c77d4f96da9447161ce84a824.tar.gz
git-bc94e5862aed854c77d4f96da9447161ce84a824.tar.bz2
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>
Diffstat (limited to 'Documentation/config')
-rw-r--r--Documentation/config/user.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/config/user.txt b/Documentation/config/user.txt
index 0557cbb..a1f80e8 100644
--- a/Documentation/config/user.txt
+++ b/Documentation/config/user.txt
@@ -13,7 +13,7 @@ committer.email::
Also, all of these can be overridden by the `GIT_AUTHOR_NAME`,
`GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_NAME`,
`GIT_COMMITTER_EMAIL` and `EMAIL` environment variables.
- See linkgit:git-commit-tree[1] for more information.
+ See linkgit:git-commit[1] for more information.
user.useConfigOnly::
Instruct Git to avoid trying to guess defaults for `user.email`