Re: [PATCH v2] checkpatch: fix TYPO_SPELLING check for words with apostrophe

[Dwaipayan Ray]

On Tue, Dec 1, 2020 at 11:32 PM Joe Perches <joe@xxxxxxxxxxx> wrote:
>
> On Tue, 2020-12-01 at 12:53 +0530, Dwaipayan Ray wrote:
> > checkpatch reports a false TYPO_SPELLING warning for some words
> > containing an apostrophe when run with --codespell option.
> >
> > A false positive is "doesn't". Occurrence of the word causes
> > checkpatch to emit the following warning:
> >
> > "WARNING: 'doesn'' may be misspelled - perhaps 'doesn't'?"
> >
> > Modify the regex pattern to be more in line with the codespell
> > default word matching regex. This fixes the word capture and
> > avoids the false warning.
> >
> > Suggested-by: Joe Perches <joe@xxxxxxxxxxx>
> > Reported-by: Peilin Ye <yepeilin.cs@xxxxxxxxx>
> > Signed-off-by: Dwaipayan Ray <dwaipayanray1@xxxxxxxxx>
> > ---
> > Changes in v2:
> > - Use the default codespell word regex.
> > - Modify commit message to specify --codespell usage
> >
> >  scripts/checkpatch.pl | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> []
> > @@ -3106,7 +3106,7 @@ sub process {
> >  # Check for various typo / spelling mistakes
> >               if (defined($misspellings) &&
> >                   ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
> > -                     while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
> > +                     while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) {
>
> This regex seems to work well, thanks.
>
> >                               my $typo = $1;
>
> A trivial improvement might be to highlight the location of the
> misspelled word with a caret using
>
>                                 my $blank = copy_spacing($rawline);
>                                 my $ptr = substr($blank, 0, $-[0] + 1) . "^";
>                                 my $hereptr = "$hereline$ptr\n";
>
> >                               my $typo_fix = $spelling_fix{lc($typo)};
> >                               $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
>
> and using $hereptr and not $hereline when emitting the message.
>
>
Sure I will do that.
Is the color highlighting also supported in most systems? Maybe a red colored
word would be nice to notice as well.

Thanks,
Dwaipayan.