Re: [PATCH v2 1/3] doc: provide guidance on user.name format

From: Jeff King <peff@peff.net>
Date: Oct 18, 2019, 05:37 UTC
Message-ID: <20191018053716.GA18384@sigill.intra.peff.net>
In-Reply-To: <20191017222038.t2qlqderp44q2m7v@camp.crustytoothpaste.net>

On Thu, Oct 17, 2019 at 10:20:38PM +0000, brian m. carlson wrote:

Show 12 quoted lines

> > >  Documentation/git-commit-tree.txt | 6 ++++++
> > >  1 file changed, 6 insertions(+)
> > 
> > ...I was surprised to see it here, where I think most users wouldn't
> > find it. Would it make sense in git-commit(1), or in the description of
> > the user.name config?
> 
> So the user.name config description points to git-commit-tree(1), which
> describes these in detail, which is why I put it there.  I agree that
> it's not a super discoverable place, since I don't know anyone that
> actually uses git commit-tree these days.  git-commit(1) doesn't
> describe these options at all.

Hmm, yeah. It's a little funny to point users at git-commit-tree, I think. Some of that documentation may go better in git-commit. But resolving that may be more than you want to bite off right now.

Show 5 quoted lines

> There are, of course, options.  I can add this text into the `user.name`
> option in git-config(5) nevertheless, which will likely be more
> discoverable, but it will split the documentation on those into two
> separate locations.  Or we can leave it in git-commit-tree(1) anyway to
> keep it together.

I like the idea of mentioning something about it in user.name, even if it's more brief ("Note that this doesn't impact the username used for network authentication; see credential.username" or something).

-Peff