Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Subject: Re: [PATCH 1/1] checkpatch: support "base-commit:" format
To:     Joe Perches <joe@perches.com>
CC:     Andy Whitcroft <apw@canonical.com>,
        Jonathan Corbet <corbet@lwn.net>,
        Konstantin Ryabitsev <konstantin@linuxfoundation.org>,
        LKML <linux-kernel@vger.kernel.org>
References: <20200212233221.47662-1-jhubbard@nvidia.com>
 <20200212233221.47662-2-jhubbard@nvidia.com>
 <a22937adb1bb364e4f5b8f30ee928a2df5cc226c.camel@perches.com>
 <2dab786b686735ec0c4ee614c64448d78c67a51d.camel@perches.com>
From:   John Hubbard <jhubbard@nvidia.com>
Message-ID: <5b8d6faf-4eec-ae8a-42e4-0b16713ed288@nvidia.com>
Date:   Wed, 12 Feb 2020 20:22:14 -0800
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101
 Thunderbird/68.4.2
MIME-Version: 1.0
In-Reply-To: <2dab786b686735ec0c4ee614c64448d78c67a51d.camel@perches.com>
Content-Type: text/plain; charset="utf-8"; format=flowed
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On 2/12/20 5:32 PM, Joe Perches wrote:
> On Wed, 2020-02-12 at 17:06 -0800, Joe Perches wrote:
>> On Wed, 2020-02-12 at 15:32 -0800, John Hubbard wrote:
>>> In order to support the get-lore-mbox.py tool described in [1], I ran:
>>>
>>>      git format-patch --base=<commit> --cover-letter <revrange>
>>>
>>> ...which generated a "base-commit: <commit-hash>" tag at the end of the
>>> cover letter. However, checkpatch.pl generated an error upon encounting
>>> "base-commit:" in the cover letter:
>>>
>>>      "ERROR: Please use git commit description style..."
>>>
>>> ...because it found the "commit" keyword, and failed to recognize that
>>> it was part of the "base-commit" phrase, and as such, should not be
>>> subjected to the same commit description style rules.
>>>
>>> Update checkpatch.pl to include a special case for "base-commit:", so
>>> that that tag no longer generates a checkpatch error.
> []
>>> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> []
>>> @@ -2761,6 +2761,7 @@ sub process {
>>>   
>>>   # Check for git id commit length and improperly formed commit descriptions
>>>   		if ($in_commit_log && !$commit_log_possible_stack_dump &&
>>> +		    $line !~ /base-commit:/ &&
>>
>> If this base-commit: entry is only at the start of line,


As far as I can tell, we should be able to rely on that, yes.


>> I presume this should actually be
>>
>> 		    $line !~ /^base-commit:/ &&
>> or maybe
>> 		    $line !~ /^\s*base-commit:/ &&
>>
>>>   		    $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
> 
> and probably better to just add it to this line instead like
> 
>   		    $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
>  

Yes, that looks nice. I'll send a v2 doing it that way.


thanks,
-- 
John Hubbard
NVIDIA