Commit d9190e4e authored May 08, 2017 by Joe Perches Committed by Linus Torvalds May 08, 2017

checkpatch: avoid suggesting struct definitions should be const

Many structs are generally used const and there is a known list of these
structs.

struct definitions should not be generally be declared const.

Add a test for the lack of an open brace immediately after the struct to
avoid definitions.

This avoids the false positive "struct foo should normally be const"
message only when the open brace is on the same line as the definition.

Link: http://lkml.kernel.org/r/0dce709150d712e66f1b90b03827634b53b28085.1491845946.git.joe@perches.com


Signed-off-by: Joe Perches <joe@perches.com>
Cc: Arthur Brainville <ybalrid@ybalrid.info>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

parent eb3a58de

scripts/checkpatch.pl

+3 −3

Original line number	Diff line number	Diff line
		@@ -6090,11 +6090,11 @@ sub process {
		}

		# check for various structs that are normally const (ops, kgdb, device_tree)
		# and avoid what seem like struct definitions 'struct foo {'
		if ($line !~ /\bconst\b/ &&
		$line =~ /\bstruct\s+($const_structs)\b/) {
		$line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
		WARN("CONST_STRUCT",
		"struct $1 should normally be const\n" .
		$herecurr);
		"struct $1 should normally be const\n" . $herecurr);
		}

		# use of NR_CPUS is usually wrong

Admin message