Re: [PATCH] blame: fix typo in documentation

From: Andrei Rybak <rybak.a.v@gmail.com>
Date: Jun 19, 2021, 11:12 UTC
Message-ID: <7cbbd59b-d5e3-4b96-a1ee-a242a7839028@gmail.com>
In-Reply-To: <8921ac50-e628-9a60-2a8d-1b8cc2a5a056@gmail.com>

On 19/06/2021 07:27, Bagas Sanjaya wrote:

Show 29 quoted lines

> On 19/06/21 05.11, Andrei Rybak wrote:
>> As can be seen in files "Documentation/blame-options.txt" and
>> "builtin/blame.c", the name of this configuration variable is
>> "blame.markUnblamableLines".
>>
>> Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
>> ---
>>   Documentation/config/blame.txt | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/config/blame.txt 
>> b/Documentation/config/blame.txt
>> index 9468e8599c..4d047c1790 100644
>> --- a/Documentation/config/blame.txt
>> +++ b/Documentation/config/blame.txt
>> @@ -27,7 +27,7 @@ blame.ignoreRevsFile::
>>       file names will reset the list of ignored revisions.  This 
>> option will
>>       be handled before the command line option `--ignore-revs-file`.
>> -blame.markUnblamables::
>> +blame.markUnblamableLines::
>>       Mark lines that were changed by an ignored revision that we 
>> could not
>>       attribute to another commit with a '*' in the output of
>>       linkgit:git-blame[1].
>>
> 
> That above is not typo fixing; that is correcting configuration variable 
> name.

This issue in documentation of git-blame was introduced when the config option was added in commit 8934ac8c92 (blame: add config options for the output of ignored or unblamable lines, 2019-05-15). It first appeared in v6 of that series [1] where it was called blame.maskIgnoredUnblamables. In v7 [2] it got renamed to blame.markUnblamableLines. v7 of that series is the first time when incorrect blame.markUnblamables appears in Documentation/config/blame.txt.

As far as I can tell, it's most probable that Barret Rhoden just missed one place when renaming this config option between v6 and v7.

If we shouldn't refer to this patch as typofix, how about

	blame: fix name of blame.markUnblamableLines in docs

or

	blame: correct name of config option in docs

or

	config/blame.txt: correct name of blame.markUnblamableLines

[1] https://lore.kernel.org/git/20190410162409.117264-5-brho@google.com/ [2] https://lore.kernel.org/git/20190515214503.77162-6-brho@google.com/