Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Subject: Re: [PATCH 2/2] checkpatch: kconfig: add missing types to regex
To:     Joe Perches <coupons@perches.com>, linux-kernel@vger.kernel.org
Cc:     apw@canonical.com, johannes.czekay@fau.de,
        linux-kernel@i4.cs.fau.de, akpm@linux-foundation.org
References: <a9797282-84c3-2c8f-73a0-d751a8201541@fau.de>
 <1f3b50a6f343dd252c043b2e5b7d47bca8514ee7.camel@perches.com>
 <5d7cef4f-071d-0504-74df-bd944a11dd70@fau.de>
 <fa637be6bb02336a3df6e3c3fdc800b9b17d079f.camel@perches.com>
From:   Nicolai Fischer <nicolai.fischer@fau.de>
Message-ID: <4899798f-46b9-32ee-4d1e-ab2b5833da08@fau.de>
Date:   Fri, 25 Dec 2020 18:27:23 +0100
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101
 Thunderbird/68.11.0
MIME-Version: 1.0
In-Reply-To: <fa637be6bb02336a3df6e3c3fdc800b9b17d079f.camel@perches.com>
Content-Type: text/plain; charset=utf-8
Content-Language: en-US
Content-Transfer-Encoding: 8bit
Precedence: bulk


On 12/21/20 6:17 PM, Joe Perches wrote:
> On Mon, 2020-12-21 at 16:08 +0100, Nicolai Fischer wrote:
>> On Sun, 2020-12-20 at 20:16 +0100, Joe Perches wrote:
>>> On Mon, 2020-12-14 at 11:24 +0100, Nicolai Fischer wrote:
>>>> Kconfig parsing does not recognise all type attributes.
>>>> This adds the missing 'int', 'sting' and 'hex' types.
>>> []
>>>> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
>>> []
>>>> @@ -3321,7 +3321,7 @@ sub process {
>>>>  				next if ($f =~ /^-/);
>>>>  				last if (!$file && $f =~ /^\@\@/);
>>>>  
>>>>
>>>> -				if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
>>>> +				if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|int|hex|string|prompt)\s*["']/) {
>>>>  					$is_start = 1;
>>>>  				} elsif ($lines[$ln - 1] =~ /^\+\s*help$/) {
>>>>  					$length = -1;
>>>
>>> Another thing that could be done is to enforce the "extra 2 spaces"
>>> indent by capturing the whitespace before the help keyword:
>>>
>>> 				} elsif ($lines[$ln - 1] =~ /^\+\s*help$/) {
>>>
>>> could be
>>>
>>> 				} elsif ($lines[$ln - 1] =~ /^\+(\s*)help\s*$/) {
>>>
>>> with $1 used to validate the extra indent.
>>>
>>>
>>
>>
>> In case the indent does not match, should we display a new warning as in our previous patch?
> 
> Sure, but in a separate patch and ensure blank lines are ignored.
> 
> +                               if ($l !~ /^\ {2}/) {
> +                                       $wrong_indent = 1;
>                                 }
> 
> The message you used:
> +                               WARN("CONFIG_DESCRIPTION",
> +                                       "help text is not indented 2 spaces more than the help keyword\n" . $herecurr);
> 
> is IMO a bit oddly phrased and could/should test only
> the first line after the help keyword and show the help
> line using $hereprev.
> 
> The problem with $herecurr is, that it always contains the first line of the Kconfig option.
The loop which actually determines if the warning is to be displayed, leaves $herecurr and likewise $hereprev unaffected.

So printing $hereprev would unfortunately not be any more helpful than $herecurr.

Because $herecurr and $hereprev also contain the line number, among other things, I am not sure what would be the best way
to address this.