linux-kernel-mentees.lists.linuxfoundation.org archive mirror
 help / color / mirror / Atom feed
From: Dwaipayan Ray <dwaipayanray1@gmail.com>
To: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc: linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [Linux-kernel-mentees] [PATCH] checkpatch: add new exceptions to repeated word check
Date: Fri, 16 Oct 2020 23:52:18 +0530	[thread overview]
Message-ID: <CABJPP5AwiEQNypApE_5svF6Rqb3YU=cZ_=V+KW494uC_LHDMXg@mail.gmail.com> (raw)
In-Reply-To: <20201016181613.129843-1-dwaipayanray1@gmail.com>

On Fri, Oct 16, 2020 at 11:46 PM Dwaipayan Ray <dwaipayanray1@gmail.com> wrote:
>
> Recently, commit 4f6ad8aa1eac ("checkpatch: move repeated word test")
> moved the repeated word test to check for more file types. But after
> this, if checkpatch.pl is run on MAINTAINERS, it generates several
> new warnings of the type:
>
> WARNING: Possible repeated word: 'git'
>
> For example:
> WARNING: Possible repeated word: 'git'
> +T:     git git://git.kernel.org/pub/scm/linux/kernel/git/rw/uml.git
>
> So, the pattern "git git://..." is a false positive in this case.
>
> There are several other combinations which may produce a wrong
> warning message, such as "@size size", "Begin; begin", etc.
>
> Extend repeated word check to compare the characters before and
> after the word matches. If the preceding or succeeding character
> belongs to the exception list, the warning is avoided.
>
> Suggested-by: Joe Perches <joe@perches.com>
> Suggested-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> Signed-off-by: Dwaipayan Ray <dwaipayanray1@gmail.com>
> ---
>  scripts/checkpatch.pl | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
>
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index f1a4e61917eb..82497a71ac96 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -595,6 +595,7 @@ our @mode_permission_funcs = (
>  );
>
>  my $word_pattern = '\b[A-Z]?[a-z]{2,}\b';
> +my $punctuation_chars = '[,:;@\.\-]';
>
>  #Create a search pattern for all these functions to speed up a loop below
>  our $mode_perms_search = "";
> @@ -3065,6 +3066,21 @@ sub process {
>                                 next if ($first ne $second);
>                                 next if ($first eq 'long');
>
> +                               # check for character before and after the word matches
> +                               my $ca_first = substr($rawline, $-[1]-1, 1);
> +                               my $cb_first = substr($rawline, $+[1], 1);
> +                               my $ca_second = substr($rawline, $-[2]-1, 1);
> +                               my $cb_second = substr($rawline, $+[2], 1);
> +
> +                               if ($ca_first ne $ca_second || $cb_first ne $cb_second) {
> +                                       if ($ca_first =~ /$punctuation_chars/ ||
> +                                           $ca_second =~ /$punctuation_chars/ ||
> +                                           $cb_first =~ /$punctuation_chars/ ||
> +                                           $cb_second =~ /$punctuation_chars/) {
> +                                               next;
> +                                       }
> +                               }
> +
>                                 if (WARN("REPEATED_WORD",
>                                          "Possible repeated word: '$first'\n" . $herecurr) &&
>                                     $fix) {
> --
> 2.27.0
>
Hi,
This patch is followed from the discussion at
https://lore.kernel.org/linux-kernel-mentees/7d8c7d80aa7b0524cca49a6dfe24e878bea6ab12.camel@perches.com/
, where Joe suggested that instead of hard coding the
particular words, we can check the surrounding
characters instead for punctuations and ingore them.

Please let me know if any changes are needed.

Thanks,
Dwaipayan.
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

  reply	other threads:[~2020-10-16 18:22 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-16 18:16 [Linux-kernel-mentees] [PATCH] checkpatch: add new exceptions to repeated word check Dwaipayan Ray
2020-10-16 18:22 ` Dwaipayan Ray [this message]
2020-10-17  5:24   ` Lukas Bulwahn

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CABJPP5AwiEQNypApE_5svF6Rqb3YU=cZ_=V+KW494uC_LHDMXg@mail.gmail.com' \
    --to=dwaipayanray1@gmail.com \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=lukas.bulwahn@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).