linux-kernel - Re: [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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <1bd0064c-d0ec-415b-9b86-47df5c13e620@riseup.net>
Date: Wed, 2 Oct 2024 21:12:46 -0300
From: André Almeida <andrealmeid@...eup.net>
To: Gabriela Bittencourt <gbittencourt@...amp.dev>
Cc: Dwaipayan Ray <dwaipayanray1@...il.com>,
 Lukas Bulwahn <lukas.bulwahn@...il.com>, Joe Perches <joe@...ches.com>,
 Andy Whitcroft <apw@...onical.com>, ~lkcamp/patches@...ts.sr.ht,
 linux-kernel@...r.kernel.org
Subject: Re: [PATCH] Add information on checkpatch warning about `help` in
 modules

Hey Gabriela!

You forgot the prefix "checkpatch: " at your commit message.

Em 28/09/2024 20:46, Gabriela Bittencourt escreveu:
> 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.
> 

I think the way is described could be more clear... maybe you could 
start by stating the problem, and then describing your solution. It 
should be clear why this change is needed and helpful. I would write 
something like this:

---
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.
---

Thanks!
	André