[132/156] checkpatch: fix false positive on empty block comment lines

Commit Message

Andrew Morton Oct. 16, 2020, 2:49 a.m. UTC

From: Łukasz Stelmach <[e-mail]>
Subject: checkpatch: fix false positive on empty block comment lines

To avoid false positives in presence of SPDX-License-Identifier in
networking files it is required to increase the leeway for empty block
comment lines by one line.

For example, checking drivers/net/loopback.c which starts with

    // SPDX-License-Identifier: GPL-2.0-or-later
    /*
     * INET          An implementation of the TCP/IP protocol suite for the LINUX

rsults in an unnecessary warning

    WARNING: networking block comments don't use an empty /* line, use /* Comment...
    +/*
    + * INET                An implementation of the TCP/IP protocol suite for the LINUX

Link: https://lkml.kernel.org/r/[e-mail]
Signed-off-by: Łukasz Stelmach <[e-mail]>
Acked-by: Joe Perches <[e-mail]>
Cc: Bartłomiej Żolnierkiewicz  <[e-mail]>
Cc: Marek Szyprowski <[e-mail]>
Signed-off-by: Andrew Morton <[e-mail]>
---

 scripts/checkpatch.pl |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Patch

--- a/scripts/checkpatch.pl~checkpatch-fix-false-positive-on-empty-block-comment-lines
+++ a/scripts/checkpatch.pl
@@ -3464,7 +3464,7 @@  sub process {
 		if ($realfile =~ m@^(drivers/net/|net/)@ &&
 		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
 		    $rawline =~ /^\+[ \t]*\*/ &&
-		    $realline > 2) {
+		    $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier
 			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
 			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
 		}