git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v4 0/6] Documentation for common user misconceptions

From
brian m. carlson <sandals@crustytoothpaste.net>
Date
Jan 20, 2020, 17:33 UTC
Message-ID
<20200120173343.4102954-1-sandals@crustytoothpaste.net>

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(-)
Next: brian m. carlson
Message 1 of 13 in “Documentation for common user misconceptions”
  1. 0/6 Documentation for common user misconceptionsbrian m. carlson, Jan 20, 2020
  2. 2/5 docs: expand on possible and recommended user config optionsbrian m. carlson, Jan 20, 2020
  3. 4/5 doc: dissuade users from trying to ignore tracked filesbrian m. carlson, Jan 20, 2020
  4. Jeff KingJan 20, 2020
  5. 1/5 doc: move author and committer information to git-commit(1)brian m. carlson, Jan 20, 2020
  6. Jeff KingJan 20, 2020
  7. brian m. carlsonJan 20, 2020
  8. Junio C HamanoJan 21, 2020
  9. Junio C HamanoJan 21, 2020
  10. 5/5 docs: mention when increasing http.postBuffer is valuablebrian m. carlson, Jan 20, 2020
  11. 3/5 doc: provide guidance on user.name formatbrian m. carlson, Jan 20, 2020
  12. Junio C HamanoJan 21, 2020
  13. Jeff KingJan 20, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.