The patch titled
Subject: checkpatch: kconfig: clarify warning for paragraph length
has been added to the -mm tree. Its filename is
checkpatch-kconfig-clarify-warning-for-paragraph-length.patch
This patch should soon appear at
https://ozlabs.org/~akpm/mmots/broken-out/checkpatch-kconfig-clarify-warning-for-paragraph-length.patch
and later at
https://ozlabs.org/~akpm/mmotm/broken-out/checkpatch-kconfig-clarify-warning-for-paragraph-length.patch
Before you just go and hit "reply", please:
a) Consider who else should be cc'ed
b) Prefer to cc a suitable mailing list as well
c) Ideally: find the original patch on the mailing list and do a
reply-to-all to that, adding suitable additional cc's
*** Remember to use Documentation/process/submit-checklist.rst when testing your code ***
The -mm tree is included into linux-next and is updated
there every 3-4 working days
------------------------------------------------------
From: Nicolai Fischer <nicolai.fischer@xxxxxx>
Subject: checkpatch: kconfig: clarify warning for paragraph length
Currently checkpatch displays a warning if it detects a help text of a
Kconfig option which is too short. However the warning does not contain
any further information.
This adds the expected and currently detected number of lines to the
warning, which makes it more obvious why checkpatch is warning.
Furthermore this makes it easier to quickly identify false positives, e.g.
when a help message contains a Kconfig keyword and falsely triggers
checkpatch to stop counting lines, it will be more apparent, because the
user can see how many lines they wrote and how many of those were counted
correctly.
Link: https://lkml.kernel.org/r/20210103075015.23946-5-nicolai.fischer@xxxxxx
Co-developed-by: Johannes Czekay <johannes.czekay@xxxxxx>
Signed-off-by: Johannes Czekay <johannes.czekay@xxxxxx>
Signed-off-by: Nicolai Fischer <nicolai.fischer@xxxxxx>
Cc: Joe Perches <joe@xxxxxxxxxxx>
Signed-off-by: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
---
scripts/checkpatch.pl | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
--- a/scripts/checkpatch.pl~checkpatch-kconfig-clarify-warning-for-paragraph-length
+++ a/scripts/checkpatch.pl
@@ -3356,7 +3356,7 @@ sub process {
}
if ($is_start && $is_end && $length < $min_conf_desc_length) {
WARN("CONFIG_DESCRIPTION",
- "please write a paragraph that describes the config symbol fully\n" . $herecurr);
+ "please write a paragraph ($length/$min_conf_desc_length lines) that describes the config symbol fully\n" . $herecurr);
}
if ($is_start && $is_end && defined $help_stat_real) {
WARN("CONFIG_DESCRIPTION",
_
Patches currently in -mm which might be from nicolai.fischer@xxxxxx are
checkpatch-kconfig-replace-help-with-help.patch
checkpatch-kconfig-add-missing-types-to-regex.patch
checkpatch-kconfig-enforce-help-text-indentation.patch
checkpatch-kconfig-clarify-warning-for-paragraph-length.patch
checkpatch-kconfig-enforce-block-indentation.patch
