linux-kernel - Re: [PATCH] checkpatch.pl: Improve WARNING on Kconfig help

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <ad8b075efc39ef10727b118ed292f3353311c6db.camel@perches.com>
Date:   Wed, 19 Dec 2018 11:17:47 -0800
From:   Joe Perches <joe@...ches.com>
To:     Igor Stoppa <igor.stoppa@...il.com>,
        Andy Whitcroft <apw@...onical.com>,
        Andi Kleen <ak@...ux.intel.com>
Cc:     igor.stoppa@...wei.com, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] checkpatch.pl: Improve WARNING on Kconfig help

On Wed, 2018-12-19 at 20:55 +0200, Igor Stoppa wrote:
> The checkpatch.pl script complains when the help section of a Kconfig
> entry is too short, but it doesn't really explain what it is looking
> for. Instead, it gives a generic warning that one should consider writing
> a paragraph.
> 
> But what it *really* checks is that the help section is at least
> .$min_conf_desc_length lines long.
> 
> Since the definition of what is a paragraph is not really carved in
> stone (and actually the primary descriptions is "5 sentences"), make the
> warning less ambiguous by expliciting the actual test condition, so that
> one doesn't have to read checkpatch.pl sources, to figure out the actual
> test.
[]
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -2931,7 +2931,7 @@ sub process {
>  			}
>  			if ($is_start && $is_end && $length < $min_conf_desc_length) {
>  				WARN("CONFIG_DESCRIPTION",
> -				     "please write a paragraph that describes the config symbol fully\n" . $herecurr);
> +				     "expecting a 'help' section of " .$min_conf_desc_length . "+ lines\n" . $herecurr);

this could also be written without the concatenations

				     "expecting a 'help' section of $min_conf_desc_length or more lines\n" . $herecurr);
or maybe
				     "please write a paragraph that describes the config symbol fully ($min_conf_desc_length or more lines)\n" . $herecurr);

Andi?
You are the originator of this text.
Do you have an opinion?