Techwizz/kernel-fxtec-pro1x
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

checkpatch: ensure kconfig help checks only apply when we are adding help

Browse source 
When checking the length of the help we need to be sure we are seeing the
whole story before erroring.  Firstly we only want to check when adding
the help in the first place.  Second we need to be sure that we are seeing
the end of the entry, nominally when there is no context below or that
context shows the start of the next entry.

Signed-off-by: Andy Whitcroft <apw@canonical.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Andy Whitcroft 2010-10-26 14:23:15 -07:00 committed by Linus Torvalds
parent 0c73b4eb7a
commit 9fe287d79b
1 changed files with 21 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
scripts/checkpatch.pl
View file

@ -1400,18 +1400,34 @@ sub process {
}
# check for Kconfig help text having a real description
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
if ($realfile =~ /Kconfig/ &&
$line =~ /\+?\s*(---)?help(---)?$/) {
$line =~ /\+\s*(?:---)?help(?:---)?$/) {
my $length = 0;
for (my $l = $linenr; defined($lines[$l]); $l++) {
my $f = $lines[$l];
my $cnt = $realcnt;
my $ln = $linenr + 1;
my $f;
my $is_end = 0;
while ($cnt > 0 && defined $lines[$ln - 1]) {
$f = $lines[$ln - 1];
$cnt-- if ($lines[$ln - 1] !~ /^-/);
$is_end = $lines[$ln - 1] =~ /^\+/;
$ln++;
next if ($f =~ /^-/);
$f =~ s/^.//;
$f =~ s/#.*//;
$f =~ s/^\s+//;
next if ($f =~ /^$/);
last if ($f =~ /^\s*config\s/);
if ($f =~ /^\s*config\s/) {
$is_end = 1;
last;
}
$length++;
}
WARN("please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($length < 4);
WARN("please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_end && $length < 4);
#print "is_end<$is_end> length<$length>\n";
}
# check we are in a valid source file if not then ignore this hunk