From: "Jason J. Herne" <jjherne@linux.vnet.ibm.com>
To: blauwirbel@gmail.com, cornelia.huck@de.ibm.com, qemu-devel@nongnu.org
Cc: "Jason J. Herne" <jjherne@linux.vnet.ibm.com>
Subject: [Qemu-devel] [PATCH v2] checkpatch: Detect newlines in error_report and other error functions
Date: Fri, 11 Dec 2015 13:30:42 -0500 [thread overview]
Message-ID: <1449858642-24267-1-git-send-email-jjherne@linux.vnet.ibm.com> (raw)
We don't want newlines embedded in error messages. This seems to be a common
problem with new code so let's try to catch it with checkpatch.
This will not catch cases where newlines are inserted into the middle of an
existing multi-line statement. But those cases should be rare.
Signed-off-by: Jason J. Herne <jjherne@linux.vnet.ibm.com>
---
scripts/checkpatch.pl | 39 +++++++++++++++++++++++++++++++++++++++
1 file changed, 39 insertions(+)
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index b0f6e11..51ea667 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2511,6 +2511,45 @@ sub process {
WARN("use QEMU instead of Qemu or QEmu\n" . $herecurr);
}
+# Qemu error function tests
+
+ # Find newlines in error function text
+ my $qemu_error_funcs = qr{error_setg|
+ error_setg_errno|
+ error_setg_win32|
+ error_set|
+ error_vprintf|
+ error_printf|
+ error_printf_unless_qmp|
+ error_vreport|
+ error_report}x;
+
+ if ($rawline =~ /\b(?:$qemu_error_funcs)\s*\(\s*\".*\\n/) {
+ WARN("Error function text should not contain newlines\n" . $herecurr);
+ }
+
+ # Continue checking for error function text that contains newlines. This
+ # check handles cases where string literals are spread over multiple lines.
+ # Example:
+ # error_report("Error msg line #1"
+ # "Error msg line #2\n");
+ my $quoted_newline_regex = qr{\+\s*\".*\\n.*\"};
+ my $continued_str_literal = qr{\+\s*\".*\"};
+
+ if ($rawline =~ /$quoted_newline_regex/) {
+ # Backtrack to first line that does not contain only a quoted literal
+ # and assume that it is the start of the statement.
+ my $i = $linenr - 2;
+
+ while (($i >= 0) & $rawlines[$i] =~ /$continued_str_literal/) {
+ $i--;
+ }
+
+ if ($rawlines[$i] =~ /\b(?:$qemu_error_funcs)\s*\(/) {
+ WARN("Error function text should not contain newlines\n" . $herecurr);
+ }
+ }
+
# check for non-portable ffs() calls that have portable alternatives in QEMU
if ($line =~ /\bffs\(/) {
ERROR("use ctz32() instead of ffs()\n" . $herecurr);
--
1.9.1
next reply other threads:[~2015-12-11 18:30 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-12-11 18:30 Jason J. Herne [this message]
2015-12-14 12:47 ` [Qemu-devel] [PATCH v2] checkpatch: Detect newlines in error_report and other error functions Markus Armbruster
2015-12-14 14:45 ` Jason J. Herne
2015-12-14 15:40 ` Markus Armbruster
2015-12-17 17:49 ` Jason J. Herne
2015-12-17 18:28 ` Markus Armbruster
2015-12-18 15:06 ` Markus Armbruster
2016-01-11 21:37 ` Markus Armbruster
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1449858642-24267-1-git-send-email-jjherne@linux.vnet.ibm.com \
--to=jjherne@linux.vnet.ibm.com \
--cc=blauwirbel@gmail.com \
--cc=cornelia.huck@de.ibm.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.