This is v4 of a series improving the documentation to cover common user misconceptions. I did opt to keep the big commit information section because I think it provides value when documenting the ordering of the variables. Otherwise, it becomes confusing to advanced users which options control what and in what order. Changes from v3: * Restructure docs around git-commit(1). * Improve wording about templating as suggested by Peff. * Document ordering between user.*, author.*, and committer.*. * Document the environment variables more thoroughly. Changes from v2: * Move author and committer information to git-commit(1) where people will look for it. * Move guidance on user.name format to git-commit(1) as well and mention a shortened form of the advice in the `user.name` description. * Use a parenthetical to describe a "personal name" without contrasting it with a username. * Offer a potential solution for people who want to ignore tracked files by recommending a templating mechanism. * Be slightly more verbose about why memory is wasted with http.postBuffer. Changes from v1: * Remove parenthetical which was confusing. * Add two more patches. brian m. carlson (5): doc: move author and committer information to git-commit(1) docs: expand on possible and recommended user config options doc: provide guidance on user.name format doc: dissuade users from trying to ignore tracked files docs: mention when increasing http.postBuffer is valuable Documentation/config/http.txt | 8 ++++++ Documentation/config/user.txt | 7 +++++- Documentation/git-commit-tree.txt | 26 ++++--------------- Documentation/git-commit.txt | 40 +++++++++++++++++++++++++++--- Documentation/git-update-index.txt | 16 ++++++++++++ Documentation/git.txt | 27 ++++++++++++++++++-- 6 files changed, 97 insertions(+), 27 deletions(-)
