mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Nicolai Fischer <nicolai.fischer@fau.de>
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
Subject: Re: [PATCH 2/2] checkpatch: kconfig: add missing types to regex
Date: Fri, 25 Dec 2020 18:27:23 +0100	[thread overview]
Message-ID: <4899798f-46b9-32ee-4d1e-ab2b5833da08@fau.de> (raw)
In-Reply-To: <fa637be6bb02336a3df6e3c3fdc800b9b17d079f.camel@perches.com>


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.

  reply	other threads:[~2020-12-25 17:28 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-14 10:24 Nicolai Fischer
2020-12-20 19:12 ` Joe Perches
2020-12-20 19:16 ` Joe Perches
2020-12-21 15:08   ` Nicolai Fischer
2020-12-21 17:17     ` Joe Perches
2020-12-25 17:27       ` Nicolai Fischer [this message]
2020-12-25 17:42         ` Joe Perches

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4899798f-46b9-32ee-4d1e-ab2b5833da08@fau.de \
    --to=nicolai.fischer@fau.de \
    --cc=akpm@linux-foundation.org \
    --cc=apw@canonical.com \
    --cc=coupons@perches.com \
    --cc=johannes.czekay@fau.de \
    --cc=linux-kernel@i4.cs.fau.de \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®