[to-be-updated] checkpatch-kconfig-clarify-warning-for-paragraph-length.patch removed from -mm tree

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



The patch titled
     Subject: checkpatch: kconfig: clarify warning for paragraph length
has been removed from the -mm tree.  Its filename was
     checkpatch-kconfig-clarify-warning-for-paragraph-length.patch

This patch was dropped because an updated version will be merged

------------------------------------------------------
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-enforce-block-indentation.patch




[Index of Archives]     [Kernel Archive]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]

  Powered by Linux