linux-kernel - Re: [PATCH v2] checkpatch: add information on warning about `help` in Kconfig

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 for Android: free password hash cracker in your pocket

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

Message-ID: <cdfad67f-1725-4c95-9016-07b2543bca9b@lkcamp.dev>
Date: Sun, 20 Oct 2024 12:21:55 -0300
From: Gabriela Bittencourt <gbittencourt@...amp.dev>
To: Andy Whitcroft <apw@...onical.com>, Joe Perches <joe@...ches.com>,
 Dwaipayan Ray <dwaipayanray1@...il.com>,
 Lukas Bulwahn <lukas.bulwahn@...il.com>, linux-kernel@...r.kernel.org,
 ~lkcamp/patches@...ts.sr.ht
Cc: André Almeida <andrealmeid@...lia.com>
Subject: Re: [PATCH v2] checkpatch: add information on warning about `help` in
 Kconfig

Hi all,

On 10/3/24 4:20 PM, Gabriela Bittencourt wrote:
> When writing a short help paragraph for a new KConfig option, developers
> are prompted the following warning:
> 
> `please write a help paragraph that fully describes the config symbol`
> 
> However, developers might get confused about this message, giving that
> they do have written a help paragraph, but checkpatch is not happy about
> it, which can be perceived as a false positive. That happens because
> checkpatch considers a fully descriptive paragraph one if at least
> `$min_conf_desc_length` lines (as of now, 4 lines).
> 
> To make the warning more clear, output in the message the expected
> length of the paragraph, so developers know better what checkpatch wants
> from them.
> 
> Suggested-by: André Almeida <andrealmeid@...lia.com>
> Signed-off-by: Gabriela Bittencourt <gbittencourt@...amp.dev>
> ---
>   scripts/checkpatch.pl | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 4427572b2477..8a6b6c22b175 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -3660,7 +3660,7 @@ sub process {
>   			    $help_length < $min_conf_desc_length) {
>   				my $stat_real = get_stat_real($linenr, $ln - 1);
>   				WARN("CONFIG_DESCRIPTION",
> -				     "please write a help paragraph that fully describes the config symbol\n" . "$here\n$stat_real\n");
> +				     "please write a help paragraph with at least $min_conf_desc_length lines that fully describes the config symbol\n" . "$here\n$stat_real\n");
>   			}
>   		}
>   
> 2.46.2
> 

Gentle ping, it's being a while, is there any chance I could get some 
opinions on this? :)
I didn't find a specific mailing list I should send this patch, but if 
there is one, I'll be happy to know and add it in the cc.

Thanks in advance,

-- 
Gabriela Bittencourt