Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1757218AbbEWG2U (ORCPT ); Sat, 23 May 2015 02:28:20 -0400 Received: from smtprelay0174.hostedemail.com ([216.40.44.174]:34683 "EHLO smtprelay.hostedemail.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1753299AbbEWG2T (ORCPT ); Sat, 23 May 2015 02:28:19 -0400 X-Session-Marker: 6A6F6540706572636865732E636F6D X-Spam-Summary: 2,0,0,,d41d8cd98f00b204,joe@perches.com,:::::::::::::::::::,RULES_HIT:41:69:355:379:541:800:960:973:982:988:989:1260:1277:1311:1313:1314:1345:1359:1373:1437:1515:1516:1518:1534:1543:1593:1594:1711:1730:1747:1777:1792:2197:2198:2199:2200:2393:2553:2559:2562:2828:3138:3139:3140:3141:3142:3353:3653:3865:3866:3867:3868:3870:3871:3874:4321:4605:5007:6261:7875:7903:7974:8531:10004:10400:10848:11026:11232:11473:11658:11914:12043:12291:12296:12517:12519:12555:12679:12683:13095:14394:21080,0,RBL:none,CacheIP:none,Bayesian:0.5,0.5,0.5,Netcheck:none,DomainCache:0,MSF:not bulk,SPF:fn,MSBL:0,DNSBL:none,Custom_rules:0:0:0 X-HE-Tag: name56_4825d09bd0217 X-Filterd-Recvd-Size: 4619 Message-ID: <1432362494.29657.40.camel@perches.com> Subject: [PATCH] checkpatch: Categorize some long line length checks From: Joe Perches To: Andrew Morton Cc: oleg.drokin@intel.com, devel@driverdev.osuosl.org, gregkh@linuxfoundation.org, kernel-janitors@vger.kernel.org, linux-kernel@vger.kernel.org, HPDD-discuss@ml01.01.org, lustre-deve@lists.lustre.org, Dan Carpenter , Mike Shuey Date: Fri, 22 May 2015 23:28:14 -0700 In-Reply-To: <1432242004.20840.68.camel@perches.com> References: <1432237849-53947-1-git-send-email-shuey@purdue.edu> <1432237849-53947-11-git-send-email-shuey@purdue.edu> <1432242004.20840.68.camel@perches.com> Content-Type: text/plain; charset="ISO-8859-1" X-Mailer: Evolution 3.12.11-0ubuntu3 Mime-Version: 1.0 Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 3653 Lines: 99 Many lines of code extend beyond the maximum line length. Some of these are possibly justified by use type. For instance: structure definitions where comments are added per member like struct foo { type member; /* some long description */ } And lines that don't fit the typical logging message style where a string constant is used like: SOME_MACRO(args, "Some long string"); Categorize these long line types so that checkpatch can use a command-line --ignore= option to avoid emitting some long line warnings. Comment the code a bit better too. Signed-off-by: Joe Perches --- scripts/checkpatch.pl | 54 +++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 44 insertions(+), 10 deletions(-) diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 89b1df4..99ce3f4 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -2510,16 +2510,50 @@ sub process { # check we are in a valid source file if not then ignore this hunk next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/); -#line length limit - if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && - $rawline !~ /^.\s*\*\s*\@$Ident\s/ && - !($line =~ /^\+\s*$logFunctions\s*$\s*(?:(KERN_\S+\s*|[^"]*))?$String\s*(?:|,|$\s*;)\s*$/ || - $line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || - $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) && - $length > $max_line_length) - { - WARN("LONG_LINE", - "line over $max_line_length characters\n" . $herecurr); +# line length limit (with some exclusions) +# +# There are 3 different line length message types: +# LONG_LINE_COMMENT a comment starts before but extends beyond length +# LONG_LINE_STRING a string starts before but extends beyond length +# LONG_LINE all other lines longer than $max_line_length +# +# if LONG_LINE is ignored, the other 2 types are also ignored +# +# LONG_LINE has a few types of lines that may extend beyong $max_line_length +# kernel-doc arguments +# logging functions like pr_info that end in a string +# lines with a single string +# #defines that are a single string + + if ($length > $max_line_length) { + my $msg_type = ""; + + # comment starts before $max_line_length + if ($line =~ /([\s$;]+)$/ && + length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { + $msg_type = "LONG_LINE_COMMENT" + + # quoted string starts before $max_line_length + } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && + length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { + $msg_type = "LONG_LINE_STRING" + + # general long longs + # exclude kernel-doc argument lines + } elsif ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && + $rawline !~ /^.\s*\*\s*\@$Ident\s/ && + # exclude logging functions that end in a string + !($line =~ /^\+\s*$logFunctions\s*$\s*(?:(KERN_\S+\s*|[^"]*))?$String\s*(?:|,|$\s*;)\s*$/ || + # exclude lines with only strings + $line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || + # exclude #defines with only strings + $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/)) { + $msg_type = "LONG_LINE"; + } + if ($msg_type ne "" && show_type("LONG_LINE")) { + WARN($msg_type, + "line over $max_line_length characters\n" . $herecurr); + } } # check for adding lines without a newline. -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/