[PATCH v2] docs: document all error message types in checkpatch

Dwaipayan Ray dwaipayanray1 at gmail.com
Thu Mar 18 19:05:58 UTC 2021


On Fri, Mar 19, 2021 at 12:33 AM Dwaipayan Ray <dwaipayanray1 at gmail.com> wrote:
>
> All the error message types now have a verbose description.
>
> Also there are two new groups of message types:
>
> - Macros, Attributes and Symbols
> - Functions and Variables
>

Lukas, could you go over this when you are free?

Also please ignore the v1 of this patch. The checkpatch change
was accidentally added to that.

Thanks!
Dwaipayan.

> Rearrange the message types to fit these new groups as needed.
>
> Signed-off-by: Dwaipayan Ray <dwaipayanray1 at gmail.com>
> ---
>
> Changes in v2:
> - Replace 4.10 kernel doc links by latest
>
>  Documentation/dev-tools/checkpatch.rst | 316 ++++++++++++++++++++++---
>  1 file changed, 278 insertions(+), 38 deletions(-)
>
> diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
> index 2671e54c8320..8ccd63a18e10 100644
> --- a/Documentation/dev-tools/checkpatch.rst
> +++ b/Documentation/dev-tools/checkpatch.rst
> @@ -280,43 +280,12 @@ API usage
>      However this is not always the case (See signal.h).
>      This message type is emitted only for includes from arch/.
>
> -  **ARRAY_SIZE**
> -    The ARRAY_SIZE(foo) macro should be preferred over
> -    sizeof(foo)/sizeof(foo[0]) for finding number of elements in an
> -    array.
> -


More information about the Linux-kernel-mentees mailing list