All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] checkpatch: make the config description warning more explicit
@ 2016-05-10 13:02 Sebastian Frias
  0 siblings, 0 replies; only message in thread
From: Sebastian Frias @ 2016-05-10 13:02 UTC (permalink / raw)
  To: Andy Whitcroft, Joe Perches; +Cc: LKML, mason

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@laposte.net>
---
 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

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2016-05-10 13:25 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2016-05-10 13:02 [PATCH] checkpatch: make the config description warning more explicit Sebastian Frias

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.