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;
Message-ID: <fa4e75fa79a89b20f903364acc604cf0796b5421.camel@perches.com>
Subject: Re: [RFC PATCH] checkpatch: correctly detect lines of help text
From:   Joe Perches <joe@perches.com>
To:     Randy Dunlap <rdunlap@infradead.org>,
        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
Date:   Wed, 02 Dec 2020 11:14:49 -0800
In-Reply-To: <16f0bfd4-61ca-48d8-c9ab-10bfc9a233ad@infradead.org>
References: <133ac827-c0d2-c5c7-39d8-7d2c17de7c76@fau.de>
         <8436bc4191d92af283ea6aa7ca450e36da653e2e.camel@perches.com>
         <16f0bfd4-61ca-48d8-c9ab-10bfc9a233ad@infradead.org>
Content-Type: text/plain; charset="ISO-8859-1"
User-Agent: Evolution 3.38.1-1 
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Precedence: bulk

On Wed, 2020-12-02 at 10:59 -0800, Randy Dunlap wrote:
> On 12/2/20 10:54 AM, Joe Perches wrote:
[]
> > 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.

Maybe a wholesale conversion of Kconfig help text could be done moving
any help block not already as the last entry to be the last entry and
indenting any paragraph help text not already indented 2 extra spaces.

Should be reasonably scriptable given the parser logic available in
scripts/kconfig/.

Something akin to the scripts/parse-maintainers.pl script.