Commit 9fe287d7 authored by Andy Whitcroft's avatar Andy Whitcroft Committed by Linus Torvalds

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

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: default avatarAndy Whitcroft <apw@canonical.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 0c73b4eb
...@@ -1400,18 +1400,34 @@ sub process { ...@@ -1400,18 +1400,34 @@ sub process {
} }
# check for Kconfig help text having a real description # 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/ && if ($realfile =~ /Kconfig/ &&
$line =~ /\+?\s*(---)?help(---)?$/) { $line =~ /\+\s*(?:---)?help(?:---)?$/) {
my $length = 0; my $length = 0;
for (my $l = $linenr; defined($lines[$l]); $l++) { my $cnt = $realcnt;
my $f = $lines[$l]; 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/#.*//;
$f =~ s/^\s+//; $f =~ s/^\s+//;
next if ($f =~ /^$/); next if ($f =~ /^$/);
last if ($f =~ /^\s*config\s/); if ($f =~ /^\s*config\s/) {
$is_end = 1;
last;
}
$length++; $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 # check we are in a valid source file if not then ignore this hunk
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment