2021-09-04 07:38:37

by Utkarsh Verma

Subject: [PATCH] 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 <[email protected]>
Signed-off-by: Utkarsh Verma <[email protected]>
---
Documentation/dev-tools/checkpatch.rst | 6 ++++++
1 file changed, 6 insertions(+)

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.
--
2.25.1

2021-09-14 21:09:55

by Jonathan Corbet

Subject: Re: [PATCH] Documentation: checkpatch: Add SPLIT_STRING message

Utkarsh Verma <[email protected]> writes:

> 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 <[email protected]>
> Signed-off-by: Utkarsh Verma <[email protected]>
> ---
> Documentation/dev-tools/checkpatch.rst | 6 ++++++
> 1 file changed, 6 insertions(+)

Applied, thanks.

jon