~lkcamp/patches

checkpatch: add information on warning about `help` in Kconfig v2 PROPOSED

Gabriela Bittencourt: 1
 checkpatch: add information on warning about `help` in Kconfig

 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/55294/mbox | git am -3
Learn more about email & git

[PATCH v2] checkpatch: add information on warning about `help` in Kconfig Export this patch

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




Hi all,