Home » Mailing list archives » linux-kernel » 2010 » March » 20

[PATCH] checkpatch: Add check for too short Kconfig descriptions

Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]
[view in full thread]
From: Andi Kleen
Subject: [PATCH] checkpatch: Add check for too short Kconfig descriptions
Date: Friday, March 19, 2010 - 7:32 pm

Author: Andi Kleen <ak@linux.intel.com>
Date:   Sat Mar 20 00:26:42 2010 +0100

    checkpatch: Add check for too short Kconfig descriptions
    
    I've seen various new Kconfigs with rather unhelpful one liner
    descriptions. Add a Kconfig warning for a minimum length of the
    Kconfig help section.

    Right now I arbitarily chose 4. The exact value can be debated.
    
    Signed-off-by: Andi Kleen <ak@linux.intel.com>

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index a4d7434..d1d36e9 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -1382,6 +1382,21 @@ sub process {
 			ERROR("trailing whitespace\n" . $herevet);
 		}
 
+# check for Kconfig help text having a real description
+		if ($realfile =~ /Kconfig/ && 
+		    $line =~ /\+?\s*(---)?help(---)?$/) {
+			my $length = 0;
+			for (my $l = $linenr; defined($lines[$l]); $l++) { 
+				my $f = $lines[$l];
+				$f =~ s/#.*//; 
+				$f =~ s/^\s+//;
+				next if ($f =~ /^$/);
+				last if ($f =~ /^\s*config\s/); 
+				$length++;
+			}
+			WARN("please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($length < 4);
+		}
+
 # check we are in a valid source file if not then ignore this hunk
 		next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
 
--
Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]
Messages in current thread:
[PATCH] checkpatch: Add check for too short Kconfig descri ..., Andi Kleen, (Fri Mar 19, 7:32 pm)
Re: [PATCH] checkpatch: Add check for too short Kconfig de ..., Tilman Schmidt, (Sat Mar 20, 6:31 am)
Re: [PATCH] checkpatch: Add check for too short Kconfig de ..., Andi Kleen, (Sat Mar 20, 7:07 am)
Re: [PATCH] checkpatch: Add check for too short Kconfig de ..., Tilman Schmidt, (Sat Mar 20, 10:24 am)
Re: [PATCH] checkpatch: Add check for too short Kconfig de ..., Andi Kleen, (Sat Mar 20, 11:03 am)
Re: [PATCH] checkpatch: Add check for too short Kconfig de ..., Tilman Schmidt, (Wed Mar 24, 5:29 am)
Re: [PATCH] checkpatch: Add check for too short Kconfig de ..., Andi Kleen, (Wed Mar 24, 6:39 am)
Re: [PATCH] checkpatch: Add check for too short Kconfig de ..., Tilman Schmidt, (Wed Mar 24, 3:31 pm)