linux-kernel - [PATCH] Add information on checkpatch warning about `help` in modules

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

Message-ID: <20240928234649.193664-1-gbittencourt@lkcamp.dev>
Date: Sat, 28 Sep 2024 20:46:44 -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: Gabriela Bittencourt <gbittencourt@...amp.dev>
Subject: [PATCH] Add information on checkpatch warning about `help` in modules

Add lines number information to warning of `module help` on Kconfig.
On the creation of a new module, if `help` section is smaller than 4
lines, checkpatch.pl gives a warning asking for a fully description. So
add the information of the minimal required lines to be considered a
fully description.

Signed-off-by: Gabriela Bittencourt <gbittencourt@...amp.dev>
---

Hi all,

I'm kind of new at linux development and I'm not sure if that's the best
solution. It is just an easy one that I found that fixes the problem.
If it should not be done as I proposed, I will be happy to change the
solution.

:)

 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