summaryrefslogtreecommitdiff
path: root/Documentation/dev-tools
diff options
context:
space:
mode:
authorUtkarsh Verma <utkarshverma294@gmail.com>2021-09-04 10:36:21 +0300
committerJonathan Corbet <corbet@lwn.net>2021-09-15 00:07:26 +0300
commitd9548979f7aee0cbff4b407e8fce4af6b6d3cab0 (patch)
tree63854356bc6d4217d30675fc233ac4449ca079ba /Documentation/dev-tools
parentd7482c0da76c15b29624dccff2304589eae4651b (diff)
downloadlinux-d9548979f7aee0cbff4b407e8fce4af6b6d3cab0.tar.xz
Documentation: checkpatch: Add SPLIT_STRING message
Add a new message type SPLIT_STRING under the 'Indentation and Line Breaks' subsection. Checkpatch documentation for the splitting of quoted strings that appear in userspace, across multiple lines. Suggested-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Signed-off-by: Utkarsh Verma <utkarshverma294@gmail.com> Link: https://lore.kernel.org/r/20210904073621.12987-1-utkarshverma294@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/dev-tools')
-rw-r--r--Documentation/dev-tools/checkpatch.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
index f0956e9ea2d8..b7a1288e96a9 100644
--- a/Documentation/dev-tools/checkpatch.rst
+++ b/Documentation/dev-tools/checkpatch.rst
@@ -710,6 +710,12 @@ Indentation and Line Breaks
See: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings
+ **SPLIT_STRING**
+ Quoted strings that appear as messages in userspace and can be
+ grepped, should not be split across multiple lines.
+
+ See: https://lore.kernel.org/lkml/20120203052727.GA15035@leaf/
+
**TRAILING_STATEMENTS**
Trailing statements (for example after any conditional) should be
on the next line.