Re: [PATCH] config: correct log.showRoot description

[Taylor Blau <me@ttaylorr.com>]

On Tue, Jun 14, 2022 at 06:14:22PM +0200, Michael J Gruber wrote:
> diff --git a/Documentation/config/log.txt b/Documentation/config/log.txt
> index 456eb07800..b210f24cca 100644
> --- a/Documentation/config/log.txt
> +++ b/Documentation/config/log.txt
> @@ -40,10 +40,10 @@ log.graphColors::
>  	history lines in `git log --graph`.
>
>  log.showRoot::
> -	If true, the initial commit will be shown as a big creation event.
> -	This is equivalent to a diff against an empty tree.
> -	Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
> -	normally hide the root commit will now show it. True by default.
> +	If `false`, tools like linkgit:git-log[1] or linkgit:git-whatchanged[1]
> +	will not treat the initial commit as a big creation event.  Any root
> +	commits in `git log -p` output would be shown without a diff attached.
> +	The default is `true`.

This looks good to me. An alternative approach which would work to would
be to replace "If `true`" with "When `true`". I have a vague preference
towards the latter, since it explains what log.showRoot does, rather
than what it does not do.

But this works just as well, and I think that I'm splitting hairs
anyways ;).

Thanks,
Taylor