checkpatch: add check for too short Kconfig descriptions (3354957a) · Commits · 戴 / test

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. [akpm@linux-foundation.org: coding-style fixes] Signed-off-by:

Andi Kleen <ak@linux.intel.com> Cc: Andy Whitcroft <apw@shadowen.org> Signed-off-by:

Andrew Morton <akpm@linux-foundation.org> Signed-off-by:

Linus Torvalds <torvalds@linux-foundation.org>

scripts/checkpatch.pl

+15 −0

Original line number	Diff line number	Diff line
		@@ -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)$/);

Admin message