checkpatch: make the config description warning more explicit

PATCH New Sebastian Frias 1 participant 1 message May 10, 2016 Checkpatch

Share & tools

Sebastian Frias

author

2016-05-10 13:25 UTC #0 lore raw

PATCH 1/1 checkpatch: make the config description warning more explicit

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 <[email protected]>

---
 scripts/checkpatch.pl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

scripts/checkpatch.pl +1 -1

index 8fc9edd..9afc06f 100755
@@ -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";
 		}

Signature · 1 line

2.1.4