| Message ID | 20180216202255.25307-3-ulfalizer@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
2018-02-17 5:22 GMT+09:00 Ulf Magnusson <ulfalizer@gmail.com>: > Currently, only Kconfig symbols are checked for a missing or short help > text, and are only checked if they are defined with the 'config' > keyword. > > To make the check more general, extend it to also check help texts for > choices and for symbols defined with the 'menuconfig' keyword. > > This increases the accuracy of the check for symbols that would already > have been checked as well, since e.g. a 'menuconfig' symbol after a help > text will be recognized as ending the preceding symbol/choice > definition. > > To increase the accuracy of the check further, also recognize 'if', > 'endif', 'menu', 'endmenu', 'endchoice', and 'source' as ending a > symbol/choice definition. Currently, this is not checked for the last symbol in a file. Perhaps, EOF could be also an ending of symbol definition. This patch is a good improvement enough, so I queued it up. If you have an idea for further improvement, v2 is welcome, of course.
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 2b404317daea..54b782fab4fd 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -2797,7 +2797,10 @@ sub process { # 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*config\s+/) { + # 'choice' is usually the last thing on the line (though + # Kconfig supports named choices), so use a word boundary + # (\b) rather than a whitespace character (\s) + $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { my $length = 0; my $cnt = $realcnt; my $ln = $linenr + 1; @@ -2822,7 +2825,13 @@ sub process { $f =~ s/#.*//; $f =~ s/^\s+//; next if ($f =~ /^$/); - if ($f =~ /^\s*config\s/) { + + # This only checks context lines in the patch + # and so hopefully shouldn't trigger false + # positives, even though some of these are + # common words in help texts + if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| + if|endif|menu|endmenu|source)\b/x) { $is_end = 1; last; }
Currently, only Kconfig symbols are checked for a missing or short help text, and are only checked if they are defined with the 'config' keyword. To make the check more general, extend it to also check help texts for choices and for symbols defined with the 'menuconfig' keyword. This increases the accuracy of the check for symbols that would already have been checked as well, since e.g. a 'menuconfig' symbol after a help text will be recognized as ending the preceding symbol/choice definition. To increase the accuracy of the check further, also recognize 'if', 'endif', 'menu', 'endmenu', 'endchoice', and 'source' as ending a symbol/choice definition. Signed-off-by: Ulf Magnusson <ulfalizer@gmail.com> --- scripts/checkpatch.pl | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-)