Re: [PATCH v3 1/4] doc: move author and committer information to git-commit(1)

From: Junio C Hamano <gitster@pobox.com>
Date: Nov 6, 2019, 01:55 UTC
Message-ID: <xmqqwocdwyy1.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <20191104221822.GA22367@sigill.intra.peff.net>

Jeff King <peff@peff.net> writes:

Show 13 quoted lines

> I think we might want to keep documentation that gets too low-level out
> of git-commit(1).
>
> So for instance, this part that got moved from commit-tree:
>
>> +A commit encapsulates:
>> +
>> +- all parent object ids
>> +- author name, email and date
>> +- committer name and email and the commit time.
>> +
>
> I think could just stay there.

Me too ;-)

Show 9 quoted lines

> ... I wonder if it would make sense to define them there in
> git.txt, giving a more user-facing description. Something like:
>
>   GIT_COMMITTER_NAME::
> 	The human-readable name used in the committer identity when
> 	creating commit or tags objects, or when writing reflogs.
> 	Overrides the user.name config.
>
> and so forth for COMMITTER_EMAIL, AUTHOR_NAME, etc.

Yup, I like that. Then either commit-tree, commit etc. can refer to the environment variables section of linkgit:git[1], or perhaps assume that the readers know that anything common across all subcommands are there in linkgit:git[1] (I prefer the former).

Thanks.