[PATCH] Documentation: checkpatch: Add SPLIT_STRING message

Dwaipayan Ray dwaipayanray1 at gmail.com
Tue Aug 3 14:52:39 UTC 2021


On Tue, Aug 3, 2021 at 7:49 PM Utkarsh Verma <utkarshverma294 at gmail.com> wrote:
>
> 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.
>
> Signed-off-by: Utkarsh Verma <utkarshverma294 at gmail.com>
> Suggested-by: Lukas Bulwahn <lukas.bulwahn at gmail.com>
> ---
>  Documentation/dev-tools/checkpatch.rst | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
> index f0956e9ea..32a26a800 100644
> --- a/Documentation/dev-tools/checkpatch.rst
> +++ b/Documentation/dev-tools/checkpatch.rst
> @@ -710,6 +710,10 @@ 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.
> +

Is there any reference you can point to for this?
Usually LKML links are okay. So you can try adding some discussion
link which helps know more about why this message is important.

>    **TRAILING_STATEMENTS**
>      Trailing statements (for example after any conditional) should be
>      on the next line.
> --
> 2.17.1
>


More information about the Linux-kernel-mentees mailing list