diff mbox series

[3/3] diff-merges: clarify log.diffMerges documentation

Message ID 20220914193102.5275-4-sorganov@gmail.com (mailing list archive)
State Accepted
Commit c34a6bd291d5bfe2bec22d1c5441f8712306a527
Headers show
Series diff-merges: minor cleanups | expand

Commit Message

Sergey Organov Sept. 14, 2022, 7:31 p.m. UTC
Signed-off-by: Sergey Organov <sorganov@gmail.com>
---
 Documentation/config/log.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Junio C Hamano Sept. 15, 2022, 6:43 p.m. UTC | #1
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?

The rest of the change does make sense.
Sergey Organov Sept. 16, 2022, 1:46 p.m. UTC | #2
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
Junio C Hamano Sept. 16, 2022, 4:21 p.m. UTC | #3
Sergey Organov <sorganov@gmail.com> writes:

> 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.

Yup, excellent.
diff mbox series

Patch

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