| Message ID | 20180216202255.25307-4-ulfalizer@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
2018-02-17 5:22 GMT+09:00 Ulf Magnusson <ulfalizer@gmail.com>: > IMO, we should discourage '---help---' for new help texts, even in cases > where it would be consistent with other help texts in the file. This > will help if we ever want to get rid of '---help---' in the future. > > Also simplify the code to only check for exactly '---help---'. Since > commit c2264564df3d ("kconfig: warn of unhandled characters in Kconfig > commands"), '---help---' is a proper keyword and can only appear in that > form. Prior to that commit, '---help---' working was more of a syntactic > quirk. > > Signed-off-by: Ulf Magnusson <ulfalizer@gmail.com> > --- > scripts/checkpatch.pl | 6 +++++- > 1 file changed, 5 insertions(+), 1 deletion(-) > > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl > index 54b782fab4fd..2784f6ab309f 100755 > --- a/scripts/checkpatch.pl > +++ b/scripts/checkpatch.pl > @@ -2817,7 +2817,11 @@ sub process { > > if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { > $is_start = 1; > - } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { > + } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) { > + if ($lines[$ln - 1] =~ "---help---") { > + WARN("CONFIG_DESCRIPTION", > + "prefer 'help' over '---help---' for new help texts\n" . $herecurr); > + } > $length = -1; > } > I applied this, but perhaps the line number for the offending part could be improved. The warning looks like this. WARNING: prefer 'help' over '---help---' for new help texts #1109: FILE: init/Kconfig:1109: +config SGETMASK_SYSCALL The #1109 points to the line of the symbol start. IMHO, it is even better to point to the '---help---' line.
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 54b782fab4fd..2784f6ab309f 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -2817,7 +2817,11 @@ sub process { if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { $is_start = 1; - } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { + } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) { + if ($lines[$ln - 1] =~ "---help---") { + WARN("CONFIG_DESCRIPTION", + "prefer 'help' over '---help---' for new help texts\n" . $herecurr); + } $length = -1; }
IMO, we should discourage '---help---' for new help texts, even in cases where it would be consistent with other help texts in the file. This will help if we ever want to get rid of '---help---' in the future. Also simplify the code to only check for exactly '---help---'. Since commit c2264564df3d ("kconfig: warn of unhandled characters in Kconfig commands"), '---help---' is a proper keyword and can only appear in that form. Prior to that commit, '---help---' working was more of a syntactic quirk. Signed-off-by: Ulf Magnusson <ulfalizer@gmail.com> --- scripts/checkpatch.pl | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)