From: SeongJae Park <[email protected]>
This patchset 1) adds support of deprecated terms in the 'checkpatch.pl'
and 2) set the 'blacklist' and 'whitelist' as deprecated with
replacement suggestion of 'blocklist' and 'allowlist', because the
suggestions are incontrovertible, doesn't make people hurt, and more
self-explanatory.
The patches are based on latest 'next/master'. You can get the complete
git tree at:
https://github.com/sjp38/linux/tree/patches/checkpatch/deprecate_blacklist_whitelist_on_next
Patch History
=============
Changes from v2
(https://lore.kernel.org/lkml/[email protected]/)
- Implement and use deprecated terms check
Changes from v1
(https://lore.kernel.org/lkml/[email protected]/)
- Remove unnecessary commit message
SeongJae Park (2):
checkpatch: support deprecated terms checking
scripts/deprecated_terms: Recommend blocklist/allowlist instead of
blacklist/whitelist
scripts/checkpatch.pl | 44 ++++++++++++++++++++++++++++++++++++
scripts/deprecated_terms.txt | 7 ++++++
2 files changed, 51 insertions(+)
create mode 100644 scripts/deprecated_terms.txt
--
2.17.1
From: SeongJae Park <[email protected]>
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 <[email protected]>
---
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
From: SeongJae Park <[email protected]>
This commit recommends the patches to replace 'blacklist' and
'whitelist' with the 'blocklist' and 'allowlist', because the new
suggestions are incontrovertible, doesn't make people hurt, and more
self-explanatory.
Signed-off-by: SeongJae Park <[email protected]>
---
scripts/deprecated_terms.txt | 2 ++
1 file changed, 2 insertions(+)
diff --git a/scripts/deprecated_terms.txt b/scripts/deprecated_terms.txt
index 6faa06451c3d..102a0c82c6a0 100644
--- a/scripts/deprecated_terms.txt
+++ b/scripts/deprecated_terms.txt
@@ -3,3 +3,5 @@
# The format of each line is:
# deprecated||suggested
#
+blacklist||blocklist
+whitelist||allowlist
--
2.17.1
On Wed, 2020-06-10 at 08:52 +0200, SeongJae Park wrote:
> From: SeongJae Park <[email protected]>
>
> 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'.
[]
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> +# 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;
> +
This is a direct copy of the spelling dictionary
loading code, so maybe these could be consolidated.
On Wed, 2020-06-10 at 08:52 +0200, SeongJae Park wrote:
> This patchset 1) adds support of deprecated terms in the 'checkpatch.pl'
> and 2) set the 'blacklist' and 'whitelist' as deprecated with
> replacement suggestion of 'blocklist' and 'allowlist', because the
> suggestions are incontrovertible, doesn't make people hurt, and more
> self-explanatory.
I don't care for the politics of the patch myself.
From a technical perspective, it may be better to
have a single routine for both spelling and whatever
this is called.
Based on Jiri's feedback[1], I'm updating the replacement suggestion of blacklist
from blocklist to denylist, as the previous one might be confused to block
layer people. Also, the new recommendation is more short ;)
[1] https://lore.kernel.org/lkml/[email protected]/
================================== >8 =========================================
From 1376e327de8316ef30c393507b29d70d38bffd05 Mon Sep 17 00:00:00 2001
From: SeongJae Park <[email protected]>
Date: Wed, 10 Jun 2020 07:23:33 +0200
Subject: [PATCH v3.1] scripts/deprecated_terms: Recommend denylist/allowlist
instead of blacklist/whitelist
This commit recommends the patches to replace 'blacklist' and
'whitelist' with the 'denylist' and 'allowlist', because the new
suggestions are incontrovertible, doesn't make people hurt, and more
self-explanatory.
Signed-off-by: SeongJae Park <[email protected]>
---
scripts/deprecated_terms.txt | 2 ++
1 file changed, 2 insertions(+)
diff --git a/scripts/deprecated_terms.txt b/scripts/deprecated_terms.txt
index 6faa06451c3d..4512ef5d5ffa 100644
--- a/scripts/deprecated_terms.txt
+++ b/scripts/deprecated_terms.txt
@@ -3,3 +3,5 @@
# The format of each line is:
# deprecated||suggested
#
+blacklist||denylist
+whitelist||allowlist
--
2.17.1
On Wed 2020-06-10 08:52:21, SeongJae Park wrote:
> From: SeongJae Park <[email protected]>
>
> This patchset 1) adds support of deprecated terms in the 'checkpatch.pl'
> and 2) set the 'blacklist' and 'whitelist' as deprecated with
> replacement suggestion of 'blocklist' and 'allowlist', because the
> suggestions are incontrovertible, doesn't make people hurt, and more
> self-explanatory.
I don't think this is good idea.
Pavel
--
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html