checkpatch: clarify the EMBEDDED_FUNCTION_NAME message

Try to make the conversion of embedded function names to "%s: ", __func__
a bit clearer.

Add a bit more information to the comment describing the test too.

Link: http://lkml.kernel.org/r/38f5d32f0aec1cd98cb9ceeedd6a736cc9a802db.1491759835.git.joe@perches.com
Signed-off-by: Joe Perches <joe@perches.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Joe Perches 2017-05-08 15:55:51 -07:00 committed by Linus Torvalds
parent e795556a58
commit e4b7d3091d
1 changed files with 7 additions and 5 deletions

View File

@ -5174,14 +5174,16 @@ sub process {
"break quoted strings at a space character\n" . $hereprev); "break quoted strings at a space character\n" . $hereprev);
} }
#check for an embedded function name in a string when the function is known # check for an embedded function name in a string when the function is known
# as part of a diff. This does not work for -f --file checking as it # This does not work very well for -f --file checking as it depends on patch
#depends on patch context providing the function name # context providing the function name or a single line form for in-file
# function declarations
if ($line =~ /^\+.*$String/ && if ($line =~ /^\+.*$String/ &&
defined($context_function) && defined($context_function) &&
get_quoted_string($line, $rawline) =~ /\b$context_function\b/) { get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
WARN("EMBEDDED_FUNCTION_NAME", WARN("EMBEDDED_FUNCTION_NAME",
"Prefer using \"%s\", __func__ to embedded function names\n" . $herecurr); "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
} }
# check for spaces before a quoted newline # check for spaces before a quoted newline