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: [RFC PATCH] checkpatch: correctly detect lines of help text
To:     Joe Perches <joe@perches.com>,
        Nicolai Fischer <nicolai.fischer@fau.de>,
        linux-kernel@vger.kernel.org, Andi Kleen <ak@linux.intel.com>
Cc:     apw@canonical.com, johannes.czekay@fau.de,
        linux-kernel@i4.cs.fau.de
References: <133ac827-c0d2-c5c7-39d8-7d2c17de7c76@fau.de>
 <8436bc4191d92af283ea6aa7ca450e36da653e2e.camel@perches.com>
From:   Randy Dunlap <rdunlap@infradead.org>
Message-ID: <16f0bfd4-61ca-48d8-c9ab-10bfc9a233ad@infradead.org>
Date:   Wed, 2 Dec 2020 10:59:10 -0800
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101
 Thunderbird/78.4.0
MIME-Version: 1.0
In-Reply-To: <8436bc4191d92af283ea6aa7ca450e36da653e2e.camel@perches.com>
Content-Type: text/plain; charset=utf-8
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 12/2/20 10:54 AM, Joe Perches wrote:
> On Wed, 2020-12-02 at 19:27 +0100, Nicolai Fischer wrote:
>> Currently, checkpatch uses keywords to determine the end
>> of a Kconfig help message which leads to false positives:
>>

> 
> I believe all the '---help---' lines have been converted to just 'help'
> so the '(?:---)?' bits here could be removed.

Yes.

> See:
> 
> commit 22a4ac026c15eba961883ed8466cb341e0447de1
> Author: Masahiro Yamada <masahiroy@kernel.org>
> Date:   Wed Jun 17 12:02:20 2020 +0900
> 
>     Revert "checkpatch: kconfig: prefer 'help' over '---help---'"
>     
>     This reverts commit 84af7a6194e493fae312a2b7fa5a3b51f76d9282.
>     
>     The conversion is done.
>     
>     Cc: Ulf Magnusson <ulfalizer@gmail.com>
>     Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
> 
[]
> 
> Indentation can vary in the help blocks.  For instance:
> 
> arch/Kconfig:   help
> arch/Kconfig-     Functions will have the stack-protector canary logic added in>
> arch/Kconfig-     of the following conditions:
> arch/Kconfig-
> arch/Kconfig-     - local variable's address used as part of the right hand sid>
> arch/Kconfig-       assignment or function argument
> arch/Kconfig-     - local variable is an array (or union containing an array),
> arch/Kconfig-       regardless of array type or length
> arch/Kconfig-     - uses register local variables
> arch/Kconfig-
> 
> This doesn't allow blank lines for multi-paragraph help text either.
> 
> I think keyword parsing is necessary and some false positives are
> inevitable as the parsing logic in a line-by-line analyzer will
> always be incomplete.


There are also large hunks of block/Kconfig and drivers/hid/Kconfig
that don't use any indentation for help text...
in case that matters here.


-- 
~Randy