From: Joe Perches <joe@perches.com>
To: Dwaipayan Ray <dwaipayanray1@gmail.com>
Cc: linux-kernel-mentees@lists.linuxfoundation.org,
linux-kernel@vger.kernel.org
Subject: Re: [Linux-kernel-mentees] [PATCH v3] checkpatch: add new exception to repeated word check
Date: Fri, 16 Oct 2020 22:41:05 -0700 [thread overview]
Message-ID: <fc47f1e6babab1044c9dece4b30200e239438931.camel@perches.com> (raw)
In-Reply-To: <20201017052243.17095-1-dwaipayanray1@gmail.com>
On Sat, 2020-10-17 at 10:52 +0530, Dwaipayan Ray 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.
>
> Link: https://lore.kernel.org/linux-kernel-mentees/81b6a0bb2c7b9256361573f7a13201ebcd4876f1.camel@perches.com/
> 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 | 17 +++++++++++++++--
> 1 file changed, 15 insertions(+), 2 deletions(-)
>
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index f1a4e61917eb..89430dfd6652 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 $exclude_chars = '[^\.\,\+\s]';
Why include a + character here?
> #Create a search pattern for all these functions to speed up a loop below
> our $mode_perms_search = "";
> @@ -3056,15 +3057,27 @@ sub process {
>
> my $first = $1;
> my $second = $2;
> -
> + my $start_pos = $-[1];
> + my $end_pos = $+[2];
> if ($first =~ /(?:struct|union|enum)/) {
> pos($rawline) += length($first) + length($second) + 1;
> next;
> }
>
> - next if ($first ne $second);
> + next if (lc($first) ne lc($second));
> next if ($first eq 'long');
>
> + # check for character before and after the word matches
> + my $start_char = '';
> + my $end_char = '';
> + $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > 0);
> + $end_char = substr($rawline, $end_pos, 1) if ($end_pos <= length($rawline));
substr uses index 0, so I believe the if should be <
> +
> + if ($start_char =~ /^$exclude_chars$/ ||
> + $end_char =~ /^$exclude_chars$/) {
> + next;
> + }
Please use "next if (test);" to be similar to the other uses above.
And this doesn't work on end of phrase or sentence.
ie: "my sentence is is, a duplicate word word."
so $end_char could be a comma or a period.
so likely the $end_char test should be !~
What is the reason to add and use $exclude_chars?
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
next prev parent reply other threads:[~2020-10-17 5:41 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-17 5:22 [Linux-kernel-mentees] [PATCH v3] checkpatch: add new exception to repeated word check Dwaipayan Ray
2020-10-17 5:41 ` Joe Perches [this message]
2020-10-17 6:02 ` Dwaipayan Ray
2020-10-17 7:28 ` Joe Perches
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=fc47f1e6babab1044c9dece4b30200e239438931.camel@perches.com \
--to=joe@perches.com \
--cc=dwaipayanray1@gmail.com \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
/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).