From: SeongJae Park <sjpark@amazon.com>
To: <akpm@linux-foundation.org>, <apw@canonical.com>, <joe@perches.com>
Cc: <colin.king@canonical.com>, <sj38.park@gmail.com>,
<linux-kernel@vger.kernel.org>, SeongJae Park <sjpark@amazon.de>
Subject: [PATCH v3 1/2] checkpatch: support deprecated terms checking
Date: Wed, 10 Jun 2020 08:52:22 +0200 [thread overview]
Message-ID: <20200610065223.29894-2-sjpark@amazon.com> (raw)
In-Reply-To: <20200610065223.29894-1-sjpark@amazon.com>
From: SeongJae Park <sjpark@amazon.de>
Some terms could be deprecated for various reasons, but it is hard to
update the entire old usages. That said, we could at least encourage
new patches to use the suggested replacements. This commit adds check
of deprecated terms in the 'checkpatch.pl' for that. The script will
get deprecated terms and suggested replacements of those from
'scripts/deprecated_terms.txt' file and warn if the deprecated terms are
used. The mechanism and the format of the file are almost the same as
that of 'spelling.txt'.
Signed-off-by: SeongJae Park <sjpark@amazon.de>
---
scripts/checkpatch.pl | 44 ++++++++++++++++++++++++++++++++++++
scripts/deprecated_terms.txt | 5 ++++
2 files changed, 49 insertions(+)
create mode 100644 scripts/deprecated_terms.txt
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 524df88f9364..970e0444dc1f 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -57,6 +57,7 @@ my $max_line_length = 100;
my $ignore_perl_version = 0;
my $minimum_perl_version = 5.10.0;
my $min_conf_desc_length = 4;
+my $deprecated_terms_file = "$D/deprecated_terms.txt";
my $spelling_file = "$D/spelling.txt";
my $codespell = 0;
my $codespellfile = "/usr/share/codespell/dictionary.txt";
@@ -692,6 +693,31 @@ our $allowed_asm_includes = qr{(?x:
)};
# memory.h: ARM has a custom one
+# Load deprecated terms and build regular expression list.
+my $deprecated_terms;
+my %deprecated_terms_fix;
+
+if (open(my $deprecates, '<', $deprecated_terms_file)) {
+ while (<$deprecates>) {
+ my $line = $_;
+
+ $line =~ s/\s*\n?$//g;
+ $line =~ s/^\s*//g;
+
+ next if ($line =~ m/^\s*#/);
+ next if ($line =~ m/^\s*$/);
+
+ my ($suspect, $fix) = split(/\|\|/, $line);
+
+ $deprecated_terms_fix{$suspect} = $fix;
+ }
+ close($deprecates);
+} else {
+ warn "No deprecated term will be found - file '$deprecated_terms_file': $!\n";
+}
+
+$deprecated_terms = join("|", sort keys %deprecated_terms_fix) if keys %deprecated_terms_fix;
+
# Load common spelling mistakes and build regular expression list.
my $misspellings;
my %spelling_fix;
@@ -2957,6 +2983,24 @@ sub process {
}
}
+# Check for deprecated terms
+ if (defined($deprecated_terms) &&
+ ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
+ while ($rawline =~ /(?:^|[^a-z@])($deprecated_terms)(?:\b|$|[^a-z@])/gi) {
+ my $deprecated_term = $1;
+ my $suggested = $deprecated_terms_fix{lc($deprecated_term)};
+ $suggested = ucfirst($suggested) if ($deprecated_term=~ /^[A-Z]/);
+ $suggested = uc($suggested) if ($deprecated_term =~ /^[A-Z]+$/);
+ my $msg_level = \&WARN;
+ $msg_level = \&CHK if ($file);
+ if (&{$msg_level}("DEPRECATED_TERM",
+ "Use of '$deprecated_term' is deprecated, please '$suggested', instead.\n" . $herecurr) &&
+ $fix) {
+ $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($deprecated_term)($|[^A-Za-z@])/$1$suggested$3/;
+ }
+ }
+ }
+
# Check for various typo / spelling mistakes
if (defined($misspellings) &&
($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
diff --git a/scripts/deprecated_terms.txt b/scripts/deprecated_terms.txt
new file mode 100644
index 000000000000..6faa06451c3d
--- /dev/null
+++ b/scripts/deprecated_terms.txt
@@ -0,0 +1,5 @@
+# License: GPLv2
+#
+# The format of each line is:
+# deprecated||suggested
+#
--
2.17.1
next prev parent reply other threads:[~2020-06-10 6:52 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-10 6:52 [PATCH v3 0/2] Recommend blocklist/allowlist instead of blacklist/whitelist SeongJae Park
2020-06-10 6:52 ` SeongJae Park [this message]
2020-06-10 7:13 ` [PATCH v3 1/2] checkpatch: support deprecated terms checking Joe Perches
2020-06-10 8:01 ` SeongJae Park
2020-06-10 8:45 ` Joe Perches
2020-06-10 9:09 ` SeongJae Park
2020-06-10 6:52 ` [PATCH v3 2/2] scripts/deprecated_terms: Recommend blocklist/allowlist instead of blacklist/whitelist SeongJae Park
2020-06-10 13:54 ` SeongJae Park
2020-06-10 7:06 ` [PATCH v3 0/2] " Joe Perches
2020-06-14 21:15 ` Pavel Machek
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=20200610065223.29894-2-sjpark@amazon.com \
--to=sjpark@amazon.com \
--cc=akpm@linux-foundation.org \
--cc=apw@canonical.com \
--cc=colin.king@canonical.com \
--cc=joe@perches.com \
--cc=linux-kernel@vger.kernel.org \
--cc=sj38.park@gmail.com \
--cc=sjpark@amazon.de \
/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).