linux-kernel - [PATCH v2 4/4] checkpatch: kconfig: clarify warning for paragraph length

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: <20201226140511.662368-5-nicolai.fischer@fau.de>
Date:   Sat, 26 Dec 2020 15:05:11 +0100
From:   Nicolai Fischer <nicolai.fischer@....de>
To:     linux-kernel@...r.kernel.org
Cc:     apw@...onical.com, johannes.czekay@....de,
        linux-kernel@...cs.fau.de, joe@...ches.com,
        akpm@...ux-foundation.org
Subject: [PATCH v2 4/4] checkpatch: kconfig: clarify warning for paragraph length

Currently checkpatch displays a warning if it detects a help text
of a Kconfig option which is too short. However the warning does
not contain any further information.
This adds the expected and currently detected number of lines
to the warning, which makes it more obvious why checkpatch
is warning.

Furthermore this makes it easier to quickly identify false
positives, e.g. when a help message contains a Kconfig keyword
and falsely triggers checkpatch to stop counting lines,
it will be more apparent, because the user can see how many lines
they wrote and how many of those were counted correctly.

Co-developed-by: Johannes Czekay <johannes.czekay@....de>
Signed-off-by: Johannes Czekay <johannes.czekay@....de>
Signed-off-by: Nicolai Fischer <nicolai.fischer@....de>
---
 scripts/checkpatch.pl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index aa2205ee9ab8..bc363933e0aa 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3356,7 +3356,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);
+				     "please write a paragraph ($length/$min_conf_desc_length lines) that describes the config symbol fully\n" . $herecurr);
 			}
 			if ($is_start && $is_end && defined $help_stat_real) {
 				WARN("CONFIG_DESCRIPTION",
-- 
2.29.2