Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Message-ID: <45c8575f69602a3ad6bc3129ab99905e9f233af0.camel@perches.com>
Subject: Re: [PATCH v7] checkpatch: add fix option for LOGICAL_CONTINUATIONS
From:   Joe Perches <joe@perches.com>
To:     Aditya <yashsri421@gmail.com>,
        Andrew Morton <akpm@linux-foundation.org>
Cc:     lukas.bulwahn@gmail.com, linux-kernel@vger.kernel.org,
        linux-kernel-mentees@lists.linuxfoundation.org
Date:   Sun, 29 Nov 2020 14:27:27 -0800
In-Reply-To: <a0f6479e-0c1b-a2f8-a265-32cc31313870@gmail.com>
References: <afaa79a6d86a4184878595ced3f2de1a92a4058c.camel@perches.com>
         <20201123102818.24364-1-yashsri421@gmail.com>
         <a0f6479e-0c1b-a2f8-a265-32cc31313870@gmail.com>
Content-Type: text/plain; charset="ISO-8859-1"
User-Agent: Evolution 3.38.1-1 
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

On Sun, 2020-11-29 at 14:25 +0530, Aditya wrote:
> On 23/11/20 3:58 pm, Aditya Srivastava wrote:
> > Currently, checkpatch warns if logical continuations are placed at the
> > start of a line and not at the end of previous line.

Acked-by: Joe Perches <joe@perches.com>

> > 
> > E.g., running checkpatch on commit 3485507fc272 ("staging:
> > bcm2835-camera: Reduce length of enum names") reports:
> > 
> > CHECK:LOGICAL_CONTINUATIONS: Logical continuations should be on the
> > previous line
> > +	if (!ret
> > +	    && camera_port ==
> > 
> > Provide a simple fix by inserting logical operator at the last
> > non-comment, non-whitespace char of the previous line and removing from
> > current line, if both the lines are additions(ie start with '+')
> > 
> > Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
> > ---
> > changes in v2: quote $operator at substitution
> > 
> > changes in v3: add a check for previous line ending with comment;
> > If so, insert $operator at the last non-comment, non-whitespace char of the previous line
> > 
> > changes in v4: improve the matching mechanism by matching line termination at comment or white space;
> > insert the operator before comments (if any) separated by a whitespace;
> > append the comment and its pre-whitespace after the inserted operator (if comment was present),
> > ie if no comment was present nothing will be inserted after the operator
> > 
> > changes in v5: improve regex for comment and line end with '$;'
> > 
> > changes in v6: remove if-check; modify commit message
> > 
> > changes in v7: add an extra '$' symbol at '$fixed[$fixlinenr - 1]' regex substitution to ensure match at line end
> > 
> > ?scripts/checkpatch.pl | 12 ++++++++++--
> > ?1 file changed, 10 insertions(+), 2 deletions(-)
> > 
> > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> > index 5b1a5a65e69a..fb3c50e0bde2 100755
> > --- a/scripts/checkpatch.pl
> > +++ b/scripts/checkpatch.pl
> > @@ -3553,8 +3553,16 @@ sub process {
> > ?
> > 
> > ?# check for && or || at the start of a line
> > ?		if ($rawline =~ /^\+\s*(&&|\|\|)/) {
> > -			CHK("LOGICAL_CONTINUATIONS",
> > -			    "Logical continuations should be on the previous line\n" . $hereprev);
> > +			my $operator = $1;
> > +			if (CHK("LOGICAL_CONTINUATIONS",
> > +				"Logical continuations should be on the previous line\n" . $hereprev) &&
> > +			    $fix && $prevrawline =~ /^\+/) {
> > +				# insert logical operator at last non-comment, non-whitepsace char on previous line
> > +				$prevline =~ /[\s$;]*$/;
> > +				my $line_end = substr($prevrawline, $-[0]);
> > +				$fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/;
> > +				$fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
> > +			}
> > ?		}
> > ?
> > 
> > ?# check indentation starts on a tab stop
> > 
> 
> Hi Joe
> You probably missed this patch. Please review :)
> 
> Thanks
> Aditya