From: Sergey Organov <sorganov@gmail.com>
Date: Fri, 16 Sep 2022 13:46:06 GMT
Subject: Re: [PATCH 3/3] diff-merges: clarify log.diffMerges documentation
Message-ID: <87leqjjuu9.fsf@osv.gnss.ru>
In-Reply-To: <xmqqr10cmqbk.fsf@gitster.g>

Junio C Hamano <gitster@pobox.com> writes:

> Sergey Organov <sorganov@gmail.com> writes:
>
>> Signed-off-by: Sergey Organov <sorganov@gmail.com>
>> ---
>>  Documentation/config/log.txt | 6 +++---
>>  1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/config/log.txt b/Documentation/config/log.txt
>> index 5250ba45fb4e..cbe34d759221 100644
>> --- a/Documentation/config/log.txt
>> +++ b/Documentation/config/log.txt
>> @@ -30,9 +30,9 @@ log.excludeDecoration::
>>  	option.
>>  
>>  log.diffMerges::
>> -	Set default diff format to be used for merge commits. See
>> -	`--diff-merges` in linkgit:git-log[1] for details.
>> -	Defaults to `separate`.
>> +	Set diff format to be used when `--diff-merges=on` is
>> +	specified, see `--diff-merges` in linkgit:git-log[1] for
>> +	details. Defaults to `separate`.
>>  
>>  log.follow::
>>  	If `true`, `git log` will act as if the `--follow` option was used when
>
> Is the reason why the patch drops "default" because the value given
> is used only when --diff-merges=on is given, and does not kick in
> when "--diff-merges=<format>" is explicitly given?

Yes, exactly. It's the --diff-merges=on that uses the default diff
format. Well, in fact "-m" uses it as well, being a synonym for
--diff-merges=on, so we might consider to mention "-m" here as well, but
I thought it's not needed as we provide a link to corresponding piece of
documentation already.

I wanted to explicitly describe what log.diffMerges affects, instead of
vague "default diff format" term causing a need to figure what in fact
it means.

Thanks,
-- Sergey Organov