History

checkpatch: check for quoted strings broken across lines

checkpatch already makes an exception to the 80-column rule for quoted strings, and Documentation/CodingStyle recommends not splitting quoted strings across lines, because it breaks the ability to grep for the string. Rather than just permitting this, actively warn about quoted strings split across lines. Test case: void context(void) { struct { unsigned magic; const char *strdata; } foo[] = { { 42, "these strings" "do not produce warnings" }, { 256, "though perhaps" "they should" }, }; pr_err("this string" " should produce a warning\n"); pr_err("this multi-line string\n" "should not produce a warning\n"); asm ("this asm\n\t" "should not produce a warning"); } Results of checkpatch on that test case: WARNING: quoted string split across lines + " should produce a warning\n"); total: 0 errors, 1 warnings, 15 lines checked

Josh Triplett committed 14 years ago

Commit ca56dc01 parent 6712d851 file · +15 −0Browse files

Showing the changes to scripts/checkpatch.pl (1 of 1 file). Show all

Unified · Split

scripts/checkpatch.pl+15−0
@@ -1772,6 +1772,21 @@ sub process { · 1771 unmodified lines
17721772 "line over 80 characters\n" . $herecurr);
17731773 }
17741774
1775+# Check for user-visible strings broken across lines, which breaks the ability
1776+# to grep for the string. Limited to strings used as parameters (those
1777+# following an open parenthesis), which almost completely eliminates false
1778+# positives, as well as warning only once per parameter rather than once per
1779+# line of the string. Make an exception when the previous string ends in a
1780+# newline (multiple lines in one string constant) or \n\t (common in inline
1781+# assembly to indent the instruction on the following line).
1782+ if ($line =~ /^\+\s*"/ &&
1783+ $prevline =~ /"\s*$/ &&
1784+ $prevline =~ /\(/ &&
1785+ $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1786+ WARN("SPLIT_STRING",
1787+ "quoted string split across lines\n" . $hereprev);
1788+ }
1789+
17751790 # check for spaces before a quoted newline
17761791 if ($rawline =~ /^.*\".*\s\\n/) {
17771792 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",