[Linux-stm32] [PATCH v2] checkpatch: use utf-8 match for spell checking

[Clement LE GOFFIC]

Hello,

A gentle reminder to review this patch.

Best regards,

Clément

On 1/2/24 17:10, Antonio Borneo wrote:
> The current code that checks for misspelling verifies, in a more
> complex regex, if $rawline matches [^\w]($misspellings)[^\w]
> 
> Being $rawline a byte-string, a utf-8 character in $rawline can
> match the non-word-char [^\w].
> E.g.:
> 	./scripts/checkpatch.pl --git 81c2f059ab9
> 	WARNING: 'ment' may be misspelled - perhaps 'meant'?
> 	#36: FILE: MAINTAINERS:14360:
> 	+M:     Clément Léger <clement.leger at bootlin.com>
> 	            ^^^^
> 
> Use a utf-8 version of $rawline for spell checking.
> 
> Signed-off-by: Antonio Borneo <antonio.borneo at foss.st.com>
> Reported-by: Clément Le Goffic <clement.legoffic at foss.st.com>
> ---
> Changes in v2:
> - use $rawline_utf8 also in the while-loop's body;
> - fix path of checkpatch in the commit message.
> ---
>   scripts/checkpatch.pl | 5 +++--
>   1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 25fdb7fda112..2d122d232c6d 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -3477,9 +3477,10 @@ sub process {
>   # Check for various typo / spelling mistakes
>   		if (defined($misspellings) &&
>   		    ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
> -			while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) {
> +			my $rawline_utf8 = decode("utf8", $rawline);
> +			while ($rawline_utf8 =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) {
>   				my $typo = $1;
> -				my $blank = copy_spacing($rawline);
> +				my $blank = copy_spacing($rawline_utf8);
>   				my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo);
>   				my $hereptr = "$hereline$ptr\n";
>   				my $typo_fix = $spelling_fix{lc($typo)};
> 
> base-commit: b85ea95d086471afb4ad062012a4d73cd328fa86