[PATCH] checkpatch: Add check for too short Kconfig descriptions
in [Kernel]
|
From: Andi Kleen on 19 Mar 2010 22:40 Author: Andi Kleen <ak(a)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(a)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)$/); -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo(a)vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
|
Pages: 1 Prev: [PATCH -v5] x86: do not free zero sized per cpu areas Next: [ANNOUNCE] TCM/ConfigFS v3.4.0-rc1 |