Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 08eb9b80 authored by Joe Perches's avatar Joe Perches Committed by Linus Torvalds
Browse files

checkpatch: test multiple line block comment alignment 

Warn when block comments are not aligned on the *

/*
 * block comment, no warning
 */

/*
  * block comment, emit warning
  */

Link: http://lkml.kernel.org/r/edb57bd330adfe024b95ec2a807d4aa7f0c8b112.1472261299.git.joe@perches.com


Signed-off-by: default avatarJoe Perches <joe@perches.com>
Reported-by: default avatarSudip Mukherjee <sudipm.mukherjee@gmail.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent f90774e1

scripts/checkpatch.pl

+19 −0
Original line number Diff line number Diff line
@@ -2979,6 +2979,25 @@ sub process { 
			     "Block comments use a trailing */ on a separate line\n" . $herecurr);

		}



# Block comment * alignment

		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment

		    (($prevrawline =~ /^\+.*?\/\*/ &&		#starting /*

		      $prevrawline !~ /\*\/[ \t]*$/) ||		#no trailing */

		     $prevrawline =~ /^\+[ \t]*\*/) &&		#starting *

		    $rawline =~ /^\+[ \t]*\*/) {		#rawline *

			$prevrawline =~ m@^\+([ \t]*/?)\*@;

			my $oldindent = expand_tabs($1);

			$rawline =~ m@^\+([ \t]*)\*@;

			my $newindent = $1;

			my $test_comment = '^\\+' . "$;" x (length($newindent) + 1);

			$newindent = expand_tabs($newindent);

			if ($line =~ /$test_comment/ &&

			    length($oldindent) ne length($newindent)) {

				WARN("BLOCK_COMMENT_STYLE",

				     "Block comments should align the * on each line\n" . $hereprev);

			}

		}



# check for missing blank lines after struct/union declarations

# with exceptions for various attributes and macros

		if ($prevline =~ /^[\+ ]};?\s*$/ &&