scripts/checkpatch: refactor & fix SPDX-License-Identifier detection

[PATCH v2 2/7] scripts/checkpatch.pl: fix various indentation mistakes

Posted by Daniel P. Berrangé 6 months, 1 week ago

From: Daniel P. Berrangé <berrange@redhat.com>

Various checks in the code were under-indented relative to other
surrounding code.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 scripts/checkpatch.pl | 98 +++++++++++++++++++++----------------------
 1 file changed, 49 insertions(+), 49 deletions(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index d355c0dad5..7675418b0b 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -1681,19 +1681,19 @@ sub process {
 
 # Check SPDX-License-Identifier references a permitted license
 		if ($rawline =~ m,SPDX-License-Identifier: (.*?)(\*/)?\s*$,) {
-		    &checkspdx($realfile, $1);
+			&checkspdx($realfile, $1);
 		}
 
 		if ($rawline =~ m,(SPDX-[a-zA-Z0-9-_]+):,) {
-		    my $tag = $1;
-		    my @permitted = qw(
-			SPDX-License-Identifier
-		    );
-
-		    unless (grep { /^$tag$/ } @permitted) {
-			ERROR("Tag $tag not permitted in QEMU code, valid " .
-			      "choices are: " . join(", ", @permitted));
-		    }
+			my $tag = $1;
+			my @permitted = qw(
+				SPDX-License-Identifier
+			);
+
+			unless (grep { /^$tag$/ } @permitted) {
+				ERROR("Tag $tag not permitted in QEMU code, valid " .
+				      "choices are: " . join(", ", @permitted));
+			}
 		}
 
 # Check for wrappage within a valid hunk of the file
@@ -2274,7 +2274,7 @@ sub process {
 
 # missing space after union, struct or enum definition
 		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
-		    ERROR("missing space after $1 definition\n" . $herecurr);
+			ERROR("missing space after $1 definition\n" . $herecurr);
 		}
 
 # check for spacing round square brackets; allowed:
@@ -2569,7 +2569,7 @@ sub process {
 
 		if ($line =~ /^.\s*(Q(?:S?LIST|SIMPLEQ|TAILQ)_HEAD)\s*\(\s*[^,]/ &&
 		    $line !~ /^.typedef/) {
-		    ERROR("named $1 should be typedefed separately\n" . $herecurr);
+			ERROR("named $1 should be typedefed separately\n" . $herecurr);
 		}
 
 # Need a space before open parenthesis after if, while etc
@@ -3118,48 +3118,48 @@ sub process {
 
 # Qemu error function tests
 
-	# Find newlines in error messages
-	my $qemu_error_funcs = qr{error_setg|
-				error_setg_errno|
-				error_setg_win32|
-				error_setg_file_open|
-				error_set|
-				error_prepend|
-				warn_reportf_err|
-				error_reportf_err|
-				error_vreport|
-				warn_vreport|
-				info_vreport|
-				error_report|
-				warn_report|
-				info_report|
-				g_test_message}x;
-
-	if ($rawline =~ /\b(?:$qemu_error_funcs)\s*\(.*\".*\\n/) {
-		ERROR("Error messages should not contain newlines\n" . $herecurr);
-	}
+		# Find newlines in error messages
+		my $qemu_error_funcs = qr{error_setg|
+					 error_setg_errno|
+					 error_setg_win32|
+					 error_setg_file_open|
+					 error_set|
+					 error_prepend|
+					 warn_reportf_err|
+					 error_reportf_err|
+					 error_vreport|
+					 warn_vreport|
+					 info_vreport|
+					 error_report|
+					 warn_report|
+					 info_report|
+					 g_test_message}x;
+
+		if ($rawline =~ /\b(?:$qemu_error_funcs)\s*\(.*\".*\\n/) {
+			ERROR("Error messages should not contain newlines\n" . $herecurr);
+		}
 
-	# Continue checking for error messages that contains newlines. This
-	# check handles cases where string literals are spread over multiple lines.
-	# Example:
-	# error_report("Error msg line #1"
-	#              "Error msg line #2\n");
-	my $quoted_newline_regex = qr{\+\s*\".*\\n.*\"};
-	my $continued_str_literal = qr{\+\s*\".*\"};
+		# Continue checking for error messages that contains newlines. This
+		# check handles cases where string literals are spread over multiple lines.
+		# Example:
+		# error_report("Error msg line #1"
+		#              "Error msg line #2\n");
+		my $quoted_newline_regex = qr{\+\s*\".*\\n.*\"};
+		my $continued_str_literal = qr{\+\s*\".*\"};
 
-	if ($rawline =~ /$quoted_newline_regex/) {
-		# Backtrack to first line that does not contain only a quoted literal
-		# and assume that it is the start of the statement.
-		my $i = $linenr - 2;
+		if ($rawline =~ /$quoted_newline_regex/) {
+			# Backtrack to first line that does not contain only a quoted literal
+			# and assume that it is the start of the statement.
+			my $i = $linenr - 2;
 
-		while (($i >= 0) & $rawlines[$i] =~ /$continued_str_literal/) {
-			$i--;
-		}
+			while (($i >= 0) & $rawlines[$i] =~ /$continued_str_literal/) {
+				$i--;
+			}
 
-		if ($rawlines[$i] =~ /\b(?:$qemu_error_funcs)\s*\(/) {
-			ERROR("Error messages should not contain newlines\n" . $herecurr);
+			if ($rawlines[$i] =~ /\b(?:$qemu_error_funcs)\s*\(/) {
+				ERROR("Error messages should not contain newlines\n" . $herecurr);
+			}
 		}
-	}
 
 # check for non-portable libc calls that have portable alternatives in QEMU
 		if ($line =~ /\bffs\(/) {
-- 
2.49.0

Re: [PATCH v2 2/7] scripts/checkpatch.pl: fix various indentation mistakes

Posted by Cédric Le Goater 6 months ago

On 5/12/25 20:24, Daniel P. Berrangé wrote:
> From: Daniel P. Berrangé <berrange@redhat.com>
> 
> Various checks in the code were under-indented relative to other
> surrounding code.
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>


Reviewed-by: Cédric Le Goater <clg@redhat.com>

Thanks,

C.


> ---
>   scripts/checkpatch.pl | 98 +++++++++++++++++++++----------------------
>   1 file changed, 49 insertions(+), 49 deletions(-)
> 
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index d355c0dad5..7675418b0b 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -1681,19 +1681,19 @@ sub process {
>   
>   # Check SPDX-License-Identifier references a permitted license
>   		if ($rawline =~ m,SPDX-License-Identifier: (.*?)(\*/)?\s*$,) {
> -		    &checkspdx($realfile, $1);
> +			&checkspdx($realfile, $1);
>   		}
>   
>   		if ($rawline =~ m,(SPDX-[a-zA-Z0-9-_]+):,) {
> -		    my $tag = $1;
> -		    my @permitted = qw(
> -			SPDX-License-Identifier
> -		    );
> -
> -		    unless (grep { /^$tag$/ } @permitted) {
> -			ERROR("Tag $tag not permitted in QEMU code, valid " .
> -			      "choices are: " . join(", ", @permitted));
> -		    }
> +			my $tag = $1;
> +			my @permitted = qw(
> +				SPDX-License-Identifier
> +			);
> +
> +			unless (grep { /^$tag$/ } @permitted) {
> +				ERROR("Tag $tag not permitted in QEMU code, valid " .
> +				      "choices are: " . join(", ", @permitted));
> +			}
>   		}
>   
>   # Check for wrappage within a valid hunk of the file
> @@ -2274,7 +2274,7 @@ sub process {
>   
>   # missing space after union, struct or enum definition
>   		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
> -		    ERROR("missing space after $1 definition\n" . $herecurr);
> +			ERROR("missing space after $1 definition\n" . $herecurr);
>   		}
>   
>   # check for spacing round square brackets; allowed:
> @@ -2569,7 +2569,7 @@ sub process {
>   
>   		if ($line =~ /^.\s*(Q(?:S?LIST|SIMPLEQ|TAILQ)_HEAD)\s*\(\s*[^,]/ &&
>   		    $line !~ /^.typedef/) {
> -		    ERROR("named $1 should be typedefed separately\n" . $herecurr);
> +			ERROR("named $1 should be typedefed separately\n" . $herecurr);
>   		}
>   
>   # Need a space before open parenthesis after if, while etc
> @@ -3118,48 +3118,48 @@ sub process {
>   
>   # Qemu error function tests
>   
> -	# Find newlines in error messages
> -	my $qemu_error_funcs = qr{error_setg|
> -				error_setg_errno|
> -				error_setg_win32|
> -				error_setg_file_open|
> -				error_set|
> -				error_prepend|
> -				warn_reportf_err|
> -				error_reportf_err|
> -				error_vreport|
> -				warn_vreport|
> -				info_vreport|
> -				error_report|
> -				warn_report|
> -				info_report|
> -				g_test_message}x;
> -
> -	if ($rawline =~ /\b(?:$qemu_error_funcs)\s*\(.*\".*\\n/) {
> -		ERROR("Error messages should not contain newlines\n" . $herecurr);
> -	}
> +		# Find newlines in error messages
> +		my $qemu_error_funcs = qr{error_setg|
> +					 error_setg_errno|
> +					 error_setg_win32|
> +					 error_setg_file_open|
> +					 error_set|
> +					 error_prepend|
> +					 warn_reportf_err|
> +					 error_reportf_err|
> +					 error_vreport|
> +					 warn_vreport|
> +					 info_vreport|
> +					 error_report|
> +					 warn_report|
> +					 info_report|
> +					 g_test_message}x;
> +
> +		if ($rawline =~ /\b(?:$qemu_error_funcs)\s*\(.*\".*\\n/) {
> +			ERROR("Error messages should not contain newlines\n" . $herecurr);
> +		}
>   
> -	# Continue checking for error messages that contains newlines. This
> -	# check handles cases where string literals are spread over multiple lines.
> -	# Example:
> -	# error_report("Error msg line #1"
> -	#              "Error msg line #2\n");
> -	my $quoted_newline_regex = qr{\+\s*\".*\\n.*\"};
> -	my $continued_str_literal = qr{\+\s*\".*\"};
> +		# Continue checking for error messages that contains newlines. This
> +		# check handles cases where string literals are spread over multiple lines.
> +		# Example:
> +		# error_report("Error msg line #1"
> +		#              "Error msg line #2\n");
> +		my $quoted_newline_regex = qr{\+\s*\".*\\n.*\"};
> +		my $continued_str_literal = qr{\+\s*\".*\"};
>   
> -	if ($rawline =~ /$quoted_newline_regex/) {
> -		# Backtrack to first line that does not contain only a quoted literal
> -		# and assume that it is the start of the statement.
> -		my $i = $linenr - 2;
> +		if ($rawline =~ /$quoted_newline_regex/) {
> +			# Backtrack to first line that does not contain only a quoted literal
> +			# and assume that it is the start of the statement.
> +			my $i = $linenr - 2;
>   
> -		while (($i >= 0) & $rawlines[$i] =~ /$continued_str_literal/) {
> -			$i--;
> -		}
> +			while (($i >= 0) & $rawlines[$i] =~ /$continued_str_literal/) {
> +				$i--;
> +			}
>   
> -		if ($rawlines[$i] =~ /\b(?:$qemu_error_funcs)\s*\(/) {
> -			ERROR("Error messages should not contain newlines\n" . $herecurr);
> +			if ($rawlines[$i] =~ /\b(?:$qemu_error_funcs)\s*\(/) {
> +				ERROR("Error messages should not contain newlines\n" . $herecurr);
> +			}
>   		}
> -	}
>   
>   # check for non-portable libc calls that have portable alternatives in QEMU
>   		if ($line =~ /\bffs\(/) {

[PATCH v2 1/7] Revert "scripts: mandate that new files have SPDX-License-Identifier"
[PATCH v2 2/7] scripts/checkpatch.pl: fix various indentation mistakes
[PATCH v2 3/7] scripts/checkpatch: introduce tracking of file start/end
[PATCH v2 4/7] scripts/checkpatch: use new hook for ACPI test data check
[PATCH v2 5/7] scripts/checkpatch: use new hook for file permissions check
[PATCH v2 6/7] scripts/checkpatch: use new hook for MAINTAINERS update check
[PATCH v2 7/7] scripts/checkpatch: reimplement mandate for SPDX-License-Identifier