mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Gabriela Bittencourt <gbittencourt@lkcamp.dev>
To: Andy Whitcroft <apw@canonical.com>, Joe Perches <joe@perches.com>,
	Dwaipayan Ray <dwaipayanray1@gmail.com>,
	Lukas Bulwahn <lukas.bulwahn@gmail.com>,
	linux-kernel@vger.kernel.org, ~lkcamp/patches@lists.sr.ht
Cc: "Gabriela Bittencourt" <gbittencourt@lkcamp.dev>,
	"André Almeida" <andrealmeid@igalia.com>
Subject: [PATCH v2] checkpatch: add information on warning about `help` in Kconfig
Date: Thu,  3 Oct 2024 16:20:00 -0300	[thread overview]
Message-ID: <20241003192012.3736-1-gbittencourt@lkcamp.dev> (raw)

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.

Suggested-by: André Almeida <andrealmeid@igalia.com>
Signed-off-by: Gabriela Bittencourt <gbittencourt@lkcamp.dev>
---
 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


             reply	other threads:[~2024-10-03 19:16 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-03 19:20 Gabriela Bittencourt [this message]
2024-10-20 15:21 ` Gabriela Bittencourt

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241003192012.3736-1-gbittencourt@lkcamp.dev \
    --to=gbittencourt@lkcamp.dev \
    --cc=andrealmeid@igalia.com \
    --cc=apw@canonical.com \
    --cc=dwaipayanray1@gmail.com \
    --cc=joe@perches.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lukas.bulwahn@gmail.com \
    --cc=~lkcamp/patches@lists.sr.ht \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®