linux-kernel - Re: [PATCH v3 3/5] checkpatch: kconfig: enforce help text indentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <13db326d-0f63-402e-b475-8f3b2ceece13@fau.de>
Date:   Tue, 5 Jan 2021 16:49:02 +0100
From:   Nicolai Fischer <nicolai.fischer@....de>
To:     Joe Perches <joe@...ches.com>, linux-kernel@...r.kernel.org
Cc:     apw@...onical.com, akpm@...ux-foundation.org,
        johannes.czekay@....de, linux-kernel@...cs.fau.de
Subject: Re: [PATCH v3 3/5] checkpatch: kconfig: enforce help text indentation



On Tue 05.01.21 09:57, Joe Perches wrote:
> On Mon, 2021-01-04 at 14:09 -0800, Joe Perches wrote:
>> On Sun, 2021-01-03 at 08:50 +0100, Nicolai Fischer wrote:
>>> Adds a new warning in case the indentation level of the
>>> first line of a Kconfig help message is not at least two spaces
>>> higher than the keyword itself.
>>> Blank lines between the message and the help keyword
>>> are ignored.
>>>
>>> Co-developed-by: Johannes Czekay <johannes.czekay@....de>
>>> Signed-off-by: Johannes Czekay <johannes.czekay@....de>
>>> Signed-off-by: Nicolai Fischer <nicolai.fischer@....de>
>>> ---
>>>
>>> Now matches indentation of two or more spaces, instead of exactly two.
>>
>> No, this should match exactly 2 and warn on any other use.
> 
> To clarify, only the first line after the help keyword needs to
> have a 2 space indent more than the help keyword and the help
> block may start with Kconfig keywords.
>> Subsequent help block lines may have more than 2 chars.

Okay, thank you for the clarification.

> 
> The help block line count should end when the indent is less than
> the help keyword indent and is a non-blank line.

We could do something like this

  if (defined $help_indent) {
    $lines[$ln - 1] =~ /^\+(\s*)\S+/;
	if (length($1) < length($help_indent)) {
	  is_end = 1; last;
  }

as an extra patch after patch 3.

Please clarify whether we should match for a smaller indent than the help
keyword or the first non-blank line after the keyword.


> 
> This should be valid:
> 
> 	help
> 	  line 1
> 	    -- reason 1
> 	    -- reason 2
> 	       continuation
> 	    -- reason 3
> 
> But this should warn only on line 1:
> 
> 	help
> 	   line 1 has a 3 space indent
> 	   -- reason 1
> 	   -- reason 2
> 	       continuation
> 	   -- reason 3
> 
>