Re: [PATCH] blame: do not mention obvious default configuration values

From: Dragan Simic <dsimic@manjaro.org>
Date: May 22, 2024, 19:13 UTC
Message-ID: <51e30846c62a1605dee8fd5b9d096222@manjaro.org>
In-Reply-To: <xmqqpltd4rfu.fsf@gitster.g>

On 2024-05-22 20:44, Junio C Hamano wrote:

Show 26 quoted lines

> diff --git a/Documentation/config/blame.txt 
> b/Documentation/config/blame.txt
> index 4d047c1790..36f965484c 100644
> --- a/Documentation/config/blame.txt
> +++ b/Documentation/config/blame.txt
> @@ -1,6 +1,6 @@
>  blame.blankBoundary::
>  	Show blank commit object name for boundary commits in
> -	linkgit:git-blame[1]. This option defaults to false.
> +	linkgit:git-blame[1].
> 
>  blame.coloring::
>  	This determines the coloring scheme to be applied to blame
> @@ -14,11 +14,9 @@ blame.date::
> 
>  blame.showEmail::
>  	Show the author email instead of author name in linkgit:git-blame[1].
> -	This option defaults to false.
> 
>  blame.showRoot::
>  	Do not treat root commits as boundaries in linkgit:git-blame[1].
> -	This option defaults to false.
> 
>  blame.ignoreRevsFile::
>  	Ignore revisions listed in the file, one unabbreviated object name 
> per

Frankly, I'd much rather see the same "If true, ..." twist [1] applied here, rather than just deleting the descriptions of the defaults. To me, such an approach eliminates any doubts, while not stressing out the actual default value.

[1] https://lore.kernel.org/git/54c318f42ce63f0575ea48f3dc1e8361@manjaro.org/