2020-11-21 12:18:12

by Aditya Srivastava

[permalink] [raw]
Subject: [PATCH v2] checkpatch: add fix option for LOGICAL_CONTINUATIONS

Currently, checkpatch warns if logical continuations are placed at the
start of a line and not at the end of previous line.

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 adding logical operator at the end of previous
line and removing from current line, if both the lines are additions
(ie start with '+')

Signed-off-by: Aditya Srivastava <[email protected]>
---
changes in v2: quote $operator at substitution

scripts/checkpatch.pl | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 5b1a5a65e69a..7cb8942b6a16 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3553,8 +3553,14 @@ 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 =~ /^\+/) {
+ # add logical operator to the previous line, remove from current line
+ $fixed[$fixlinenr - 1] .= " $operator";
+ $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
+ }
}

# check indentation starts on a tab stop
--
2.17.1


2020-11-21 17:00:14

by Joe Perches

[permalink] [raw]
Subject: Re: [PATCH v2] checkpatch: add fix option for LOGICAL_CONTINUATIONS

On Sat, 2020-11-21 at 17:45 +0530, 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.
>
> 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 adding logical operator at the end of previous
> line and removing from current line, if both the lines are additions
> (ie start with '+')
[]
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -3553,8 +3553,14 @@ 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 =~ /^\+/) {
> + # add logical operator to the previous line, remove from current line
> + $fixed[$fixlinenr - 1] .= " $operator";
> + $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
> + }

One thing to be concerned about is a statement like

if (foo // comment
&& bar)

This should really perform the insertion at the last
non-comment, non-whitespace char of the previous line.


2020-11-21 18:18:09

by Aditya Srivastava

[permalink] [raw]
Subject: [PATCH v3] checkpatch: add fix option for LOGICAL_CONTINUATIONS

Currently, checkpatch warns if logical continuations are placed at the
start of a line and not at the end of previous line.

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 adding logical operator at the end of previous
line and removing from current line, if both the lines are additions
(ie start with '+')

Signed-off-by: Aditya Srivastava <[email protected]>
---
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

scripts/checkpatch.pl | 18 ++++++++++++++++--
1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 5b1a5a65e69a..533c4a6bbf12 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3553,8 +3553,22 @@ 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 =~ /^\+/) {
+ # add logical operator to the previous line, remove from current line
+ # if last line ends with a comment
+ if ($prevrawline =~ /(\/\/.*)$/) {
+ my $comment = trim($1);
+ $fixed[$fixlinenr - 1] =~ s/\s*$comment//;
+ $fixed[$fixlinenr - 1] .= " $operator $comment";
+ }
+ else {
+ $fixed[$fixlinenr - 1] .= " $operator";
+ }
+ $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
+ }
}

# check indentation starts on a tab stop
--
2.17.1

2020-11-21 18:36:40

by Joe Perches

[permalink] [raw]
Subject: Re: [PATCH v3] checkpatch: add fix option for LOGICAL_CONTINUATIONS

On Sat, 2020-11-21 at 23:43 +0530, 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.
>
> 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 adding logical operator at the end of previous
> line and removing from current line, if both the lines are additions
> (ie start with '+')
>
> Signed-off-by: Aditya Srivastava <[email protected]>
> ---
> 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
[]
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -3553,8 +3553,22 @@ 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 =~ /^\+/) {
> + # add logical operator to the previous line, remove from current line
> + # if last line ends with a comment
> + if ($prevrawline =~ /(\/\/.*)$/) {

Not the best mechanism.

check $prevline =~ /[\s$;]*$/ and use the starting position of any
match as the insertion point, and then insert the operator and
matching bits from the $prevrawline.

I'll leave that as an exercise for you for now.

> + my $comment = trim($1);
> + $fixed[$fixlinenr - 1] =~ s/\s*$comment//;
> + $fixed[$fixlinenr - 1] .= " $operator $comment";


2020-11-21 21:07:44

by Aditya Srivastava

[permalink] [raw]
Subject: [PATCH v4] checkpatch: add fix option for LOGICAL_CONTINUATIONS

Currently, checkpatch warns if logical continuations are placed at the
start of a line and not at the end of previous line.

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 adding logical operator at the end of previous
line and removing from current line, if both the lines are additions
(ie start with '+')

Signed-off-by: Aditya Srivastava <[email protected]>
---
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

scripts/checkpatch.pl | 15 +++++++++++++--
1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 5b1a5a65e69a..43a05519665d 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3553,8 +3553,19 @@ 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 =~ /^\+/) {
+ # add logical operator to the previous line, remove from current line
+ # match line termination at comment or whitespace
+ if ($prevrawline =~ /(\s*(?:\/\/.*)*)$/) {
+ my $match = $1;
+ $fixed[$fixlinenr - 1] =~ s/$match//;
+ $fixed[$fixlinenr - 1] .= " $operator$match";
+ }
+ $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
+ }
}

# check indentation starts on a tab stop
--
2.17.1

2020-11-22 02:40:21

by Joe Perches

[permalink] [raw]
Subject: Re: [PATCH v4] checkpatch: add fix option for LOGICAL_CONTINUATIONS

On Sun, 2020-11-22 at 02:34 +0530, 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.
>
> 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 adding logical operator at the end of previous
> line and removing from current line, if both the lines are additions
> (ie start with '+')
>
> Signed-off-by: Aditya Srivastava <[email protected]>
> ---
> 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

nak. I gave you a hint to the match string to use.

$prevline =~ /[\s$;]*$/

this matches either /* foo */ or // foo comment styles
(or optional blanks before EOL)

Try something like:
---
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index fab38b493cef..3c78cf0c219f 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3434,8 +3434,15 @@ 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 =~ /^\+/) {
+ # add logical operator to the previous line, remove from current line
+ $prevline =~ /([\s$;]*$)/;
+ substr($fixed[$fixlinenr - 1], $-[0]) = " $operator" . substr($prevrawline, $-[0],$+[0]);
+ $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
+ }
}

# check indentation starts on a tab stop

2020-11-22 11:13:35

by Aditya Srivastava

[permalink] [raw]
Subject: [PATCH v5] checkpatch: add fix option for LOGICAL_CONTINUATIONS

Currently, checkpatch warns if logical continuations are placed at the
start of a line and not at the end of previous line.

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 adding logical operator at the end of previous
line and removing from current line, if both the lines are additions
(ie start with '+')

Signed-off-by: Aditya Srivastava <[email protected]>
---
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 '$;'

scripts/checkpatch.pl | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 5b1a5a65e69a..708a56f31466 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3553,8 +3553,17 @@ 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 =~ /^\+/) {
+ # add logical operator to the previous line, remove from current line
+ if ($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
--
2.17.1

2020-11-22 11:37:48

by Joe Perches

[permalink] [raw]
Subject: Re: [PATCH v5] checkpatch: add fix option for LOGICAL_CONTINUATIONS

On Sun, 2020-11-22 at 16:40 +0530, 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.
>
> 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 adding logical operator at the end of previous
> line and removing from current line, if both the lines are additions
> (ie start with '+')

Not quite yet.

> changes in v5: improve regex for comment and line end with '$;'
[]
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -3553,8 +3553,17 @@ 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 =~ /^\+/) {
> + # add logical operator to the previous line, remove from current line
> + if ($prevline =~ /[\s$;]*$/) {

This if is misleading as it will always match at least the EOL

> + my $line_end = substr($prevrawline, $-[0]);
> + $fixed[$fixlinenr - 1] =~ s/\Q$line_end\E/ $operator$line_end/;

It makes it seem as if this part is only done when the test is true.
The test is always true.


2020-11-22 11:37:48

by Joe Perches

[permalink] [raw]
Subject: Re: [PATCH v5] checkpatch: add fix option for LOGICAL_CONTINUATIONS

On Sun, 2020-11-22 at 16:40 +0530, 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.
>
> 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 adding logical operator at the end of previous
> line and removing from current line, if both the lines are additions
> (ie start with '+')
>
> Signed-off-by: Aditya Srivastava <[email protected]>
> ---
> 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 '$;'
>
> ?scripts/checkpatch.pl | 13 +++++++++++--
> ?1 file changed, 11 insertions(+), 2 deletions(-)
>
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 5b1a5a65e69a..708a56f31466 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -3553,8 +3553,17 @@ 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 =~ /^\+/) {
> + # add logical operator to the previous line, remove from current line
> + if ($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


2020-11-22 13:03:01

by Aditya Srivastava

[permalink] [raw]
Subject: [PATCH v6] checkpatch: add fix option for LOGICAL_CONTINUATIONS

Currently, checkpatch warns if logical continuations are placed at the
start of a line and not at the end of previous line.

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 <[email protected]>
---
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

scripts/checkpatch.pl | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 5b1a5a65e69a..dc5b031b45b9 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
--
2.17.1

2020-11-23 06:27:07

by Joe Perches

[permalink] [raw]
Subject: Re: [PATCH v6] checkpatch: add fix option for LOGICAL_CONTINUATIONS

On Sun, 2020-11-22 at 18:29 +0530, 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.
>
> 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 <[email protected]>
[]
> diff --git 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/;

This doesn't work when the same leading whitespace and trailing whitespace
characters exist.

You need to use something like:

$fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/;

(note the $ after \E to use EOL)


2020-11-23 23:27:22

by Aditya Srivastava

[permalink] [raw]
Subject: [PATCH v7] checkpatch: add fix option for LOGICAL_CONTINUATIONS

Currently, checkpatch warns if logical continuations are placed at the
start of a line and not at the end of previous line.

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 <[email protected]>
---
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
--
2.17.1

2020-11-29 08:58:24

by Aditya Srivastava

[permalink] [raw]
Subject: Re: [PATCH v7] checkpatch: add fix option for LOGICAL_CONTINUATIONS

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.
>
> 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 <[email protected]>
> ---
> 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

2020-11-29 22:32:47

by Joe Perches

[permalink] [raw]
Subject: Re: [PATCH v7] checkpatch: add fix option for LOGICAL_CONTINUATIONS

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 <[email protected]>

> >
> > 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 <[email protected]>
> > ---
> > 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