~lkcamp/patches

Add information on checkpatch warning about `help` in modules v1 PROPOSED

Gabriela Bittencourt: 1
 Add information on checkpatch warning about `help` in modules

 1 files changed, 1 insertions(+), 1 deletions(-)
Export patchset (mbox)
How do I use this?

Copy & paste the following snippet into your terminal to import this patchset into git:

curl -s https://lists.sr.ht/~lkcamp/patches/patches/55240/mbox | git am -3
Learn more about email & git

[PATCH] Add information on checkpatch warning about `help` in modules Export this patch

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@lkcamp.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
Hey Gabriela!

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

Em 28/09/2024 20:46, Gabriela Bittencourt escreveu: