[PATCH] checkpatch: make the config description warning more explicit

From: Sebastian Frias
Date: Tue May 10 2016 - 09:25:34 EST


checkpatch.pl currently warns if Kconfig options are properly
described by checking the length of the config description.

This patch is an attempt to make the message less cryptic.

Signed-off-by: Sebastian Frias <sf84@xxxxxxxxxxx>
---
scripts/checkpatch.pl | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 8fc9edd..9afc06f 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2663,7 +2663,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);
+ "description is too short ($length lines), please write at least $min_conf_desc_length lines to describe the config symbol fully\n" . $herecurr);
}
#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
}
--
2.1.4