linux-kernel - Re: [PATCH v5 0/2] checkpatch: add verbose mode

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <cda9541eb8cff5cbba178d6a6d511a46f193aab1.camel@perches.com>
Date:   Sat, 20 Feb 2021 07:14:46 -0800
From:   Joe Perches <joe@...ches.com>
To:     Dwaipayan Ray <dwaipayanray1@...il.com>
Cc:     lukas.bulwahn@...il.com,
        linux-kernel-mentees@...ts.linuxfoundation.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v5 0/2] checkpatch: add verbose mode

On Sat, 2021-02-20 at 17:32 +0530, Dwaipayan Ray wrote:
> Add a new verbose mode to checkpatch. The verbose test
> descriptions are read from the checkpatch documentation
> file at `Documentation/dev-tools/checkpatch.rst`.
> 
> The verbose mode is optional and can be enabled by the
> flag -v or --verbose.
> 
> The documentation file is only parsed by checkpatch.pl
> if the verbose mode is enabled. The verbose mode can
> not be used together with the --terse option.
> 
> Changes in v5:
> - Change the reference format to use absolute links.
> - Print verbose descriptions only for the first time
>   a message type is encountered.

OK, I think a nice addition would be to add --verbose
text to the --list-types option when used together.

$ ./scripts/checkpatch.pl --list-types --verbose
1	ALLOC_ARRAY_ARGS

	The first argument for kcalloc or kmalloc_array should be the
	number of elements.  sizeof() as the first argument is generally
	wrong.

	See: https://www.kernel.org/doc/html/latest/core-api/memory-allocation.html

2	ALLOC_SIZEOF_STRUCT

	The allocation style is bad.  In general for family of
	allocation functions using sizeof() to get memory size,
	constructs like::

	p = alloc(sizeof(struct foo), ...)

	should be::

	p = alloc(sizeof(*p), ...)

	See: https://www.kernel.org/doc/html/latest/process/coding-style.html#allocating-memory

etc...