From: "brian m. carlson" <sandals@crustytoothpaste.net>
To: <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>,
Emily Shaffer <emilyshaffer@google.com>
Subject: [PATCH v4 0/6] Documentation for common user misconceptions
Date: Mon, 20 Jan 2020 17:33:38 +0000 [thread overview]
Message-ID: <20200120173343.4102954-1-sandals@crustytoothpaste.net> (raw)
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 reply other threads:[~2020-01-20 17:33 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-20 17:33 brian m. carlson [this message]
2020-01-20 17:33 ` [PATCH v4 1/5] doc: move author and committer information to git-commit(1) brian m. carlson
2020-01-20 17:52 ` Jeff King
2020-01-20 19:22 ` brian m. carlson
2020-01-21 22:24 ` Junio C Hamano
2020-01-21 22:23 ` Junio C Hamano
2020-01-20 17:33 ` [PATCH v4 2/5] docs: expand on possible and recommended user config options brian m. carlson
2020-01-20 17:33 ` [PATCH v4 3/5] doc: provide guidance on user.name format brian m. carlson
2020-01-21 22:35 ` Junio C Hamano
2020-01-20 17:33 ` [PATCH v4 4/5] doc: dissuade users from trying to ignore tracked files brian m. carlson
2020-01-20 17:54 ` Jeff King
2020-01-20 17:33 ` [PATCH v4 5/5] docs: mention when increasing http.postBuffer is valuable brian m. carlson
2020-01-20 17:55 ` [PATCH v4 0/6] Documentation for common user misconceptions Jeff King
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200120173343.4102954-1-sandals@crustytoothpaste.net \
--to=sandals@crustytoothpaste.net \
--cc=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).