Re: [PATCH v3 0/4] Documentation for common user misconceptions

From: Jeff King <peff@peff.net>
Date: Nov 4, 2019, 22:26 UTC
Message-ID: <20191104222634.GC22367@sigill.intra.peff.net>
In-Reply-To: <20191102192615.10013-1-sandals@crustytoothpaste.net>

On Sat, Nov 02, 2019 at 07:26:11PM +0000, brian m. carlson wrote:

Show 14 quoted lines

> This series includes four patches that update the documentation to
> address common user misconceptions.
> 
> 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.

Thanks. I think this is an improvement over v1, but I'm still a little iffy on some of the other movement in the first patch.

TBH, I don't think it's making anything _worse_, but I think it highlights how some of our documentation is a mish-mash of low-level and high-level details. ;) So it might be a good opportunity to at least clean up the documentation around ident environment variables.

-Peff