linux-kernel - [PATCH v1] checkpatch: test missing initial blank line in block comment

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-next>] [day] [month] [year] [list]

Date:   Mon, 3 Apr 2017 10:08:14 +0200
From:   Hugues Fruchet <hugues.fruchet@...com>
To:     Andy Whitcroft <apw@...onical.com>, Joe Perches <joe@...ches.com>
CC:     <linux-kernel@...r.kernel.org>
Subject: [PATCH v1] checkpatch: test missing initial blank line in block comment

Hi checkpatch maintainers,

here is a patch tentative to raise a warning when multiple line block comments
are not starting with empty blank comment:

Warn when block comments are not starting with blank comment:
    /* multiple lines
     * block comment,
     * => warning
     */

    /*
     * multiple lines
     * block comment,
     * => no warning
     */

Exception made for networking files where rule is the
exact opposite.


* sample output:

$ scripts/checkpatch.pl -f drivers/media/v4l2-core/* | grep empty -A2
WARNING: Block comments starts with an empty /*
#393: FILE: drivers/media/v4l2-core/v4l2-compat-ioctl32.c:393:
+	/* For MMAP, driver might've set up the offset, so copy it back.
--
WARNING: Block comments starts with an empty /*
#661: FILE: drivers/media/v4l2-core/v4l2-ctrls.c:661:
+	/* The MPEG controls are applicable to all codec controls
--
+	/* Add immediately at the end of the list if the list is empty, or if
+	   the last element in the list has a lower ID.
[...]


* sample output in drivers/net/ (non-regression check):

$ scripts/checkpatch.pl -f drivers/net/*/* | grep empty -A2
WARNING: networking block comments don't use an empty /* line, use /* Comment...
#39: FILE: drivers/net/appletalk/cops.c:39:
+/*
--
WARNING: networking block comments don't use an empty /* line, use /* Comment...
#45: FILE: drivers/net/appletalk/cops.c:45:
+/*
--
[...]

Hugues Fruchet (1):
  checkpatch: test missing initial blank line in block comment

 scripts/checkpatch.pl | 11 +++++++++++
 1 file changed, 11 insertions(+)

-- 
1.9.1