linux-kernel - Re: [PATCH v3] docs: checkpatch: Document and segregate more checkpatch message types

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <alpine.DEB.2.21.2106141330240.27009@felia>
Date:   Mon, 14 Jun 2021 15:49:22 +0200 (CEST)
From:   Lukas Bulwahn <lukas.bulwahn@...il.com>
To:     Dwaipayan Ray <dwaipayanray1@...il.com>
cc:     corbet@....net, linux-kernel@...r.kernel.org,
        lukas.bulwahn@...il.com, joe@...ches.com, linux-doc@...r.kernel.org
Subject: Re: [PATCH v3] docs: checkpatch: Document and segregate more checkpatch
 message types



On Fri, 11 Jun 2021, Dwaipayan Ray wrote:

> Add and document more checkpatch message types. About 50% of all
> message types are documented now.
> 
> In addition to this:
> 
> - Create a new subsection 'Indentation and Line Breaks'.
> - Rename subsection 'Comment style' to simply 'Comments'.
> - Refactor some of the existing types to appropriate subsections.
> 
> Signed-off-by: Dwaipayan Ray <dwaipayanray1@...il.com>

Reviewed-by: Lukas Bulwahn <lukas.bulwahn@...il.com>
Tested-by: Lukas Bulwahn <lukas.bulwahn@...il.com>

'make htmldocs' produces no new warnings.

See one further comment on the html presentation below; other than that no 
further comments.

Lukas

> ---
> 
> Changes in v3:
> - Update explanation for CONSTANT_CONVERSION
> - Add more reference links
> - Fix grammatical errors
> 
> Changes in v2:
> - Correct DEVICE_ATTR message types as suggested by Joe Perches.
>   https://lore.kernel.org/lkml/eab0487d7b4e68badbbe0505b2a7903b9d8931c4.camel@perches.com/T/#t
> - Use passive voice in the documentation
> 
>  Documentation/dev-tools/checkpatch.rst | 397 ++++++++++++++++++++-----
>  1 file changed, 327 insertions(+), 70 deletions(-)
> 
> diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
> index 87b859f321de..ad84e709aa25 100644
> --- a/Documentation/dev-tools/checkpatch.rst
> +++ b/Documentation/dev-tools/checkpatch.rst

<snip>
> +
> +  **FUNCTION_ARGUMENTS**
> +    This warning is emitted due to any of the following reasons::

I think here you wnt to have an enumeration, but the "::" makes it
a code block.

> +
> +      1. Arguments for the function declaration do not follow
> +         the identifier name.  Example::
> +
> +           void foo
> +           (int bar, int baz)
> +
> +         This should be corrected to::
> +
> +           void foo(int bar, int baz)
> +
> +      2. Some arguments for the function definition do not
> +         have an identifier name.  Example::
> +
> +           void foo(int)
> +
> +         All arguments should have identifier names.
> +
>    **FUNCTION_WITHOUT_ARGS**
>      Function declarations without arguments like::
>