Recommend blocklist/allowlist instead of blacklist/whitelist
v3 cover Recommend blocklist/allowlist instead of blacklist/whitelist
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
Signature · 1 line
2.17.1
PATCH v3 1/2 checkpatch: support deprecated terms checking
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'.
--- scripts/checkpatch.pl | 44 ++++++++++++++++++++++++++++++++++++ scripts/deprecated_terms.txt | 5 ++++ 2 files changed, 49 insertions(+) create mode 100644 scripts/deprecated_terms.txt
scripts/checkpatch.pl +44 -0
@@ -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)) {
scripts/deprecated_terms.txt new file +5 -0
@@ -0,0 +1,5 @@ +# License: GPLv2 +# +# The format of each line is: +# deprecated||suggested +#
Signature · 1 line
2.17.1
Joe Perches
maintainerRe: [PATCH v3 1/2] checkpatch: support deprecated terms checking
Quoted 10 lines · SeongJae Park
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'.
[]
scripts/checkpatch.pl
Quoted 1 line
scripts/checkpatch.pl +0
-0
[]
Quoted 15 lines
scripts/checkpatch.pl +15
-0+# 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);
scripts/checkpatch.pl our $allowed_asm_includes = qr{(?x: · line 720
Quoted 10 lines
scripts/checkpatch.pl +10
-0+ + $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.
Re: Re: [PATCH v3 1/2] checkpatch: support deprecated terms checking
Quoted 34 lines · On Wed, 10 Jun 2020 00:13:42 -0700 Joe Perches <[email protected]> wrote:
Quoted 10 lines · SeongJae Park
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'.[]
scripts/checkpatch.pl
Quoted 1 line
scripts/checkpatch.pl +0
-0[]
Quoted 20 lines
scripts/checkpatch.pl +20
-0+# 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 {
Quoted 8 lines
scripts/checkpatch.pl
Quoted 5 lines
scripts/checkpatch.pl +5
-0+ 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.
Agreed, how about below one?
============================= >8 ============================================ From 76987b0f062c981243b49b7bede8b68de30ac3e2 Mon Sep 17 00:00:00 2001
From: SeongJae Park <[email protected]>
Date: Wed, 10 Jun 2020 07:11:57 +0200
Subject: [PATCH] checkpatch: support deprecated terms checking
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'. For the reason, this commit modularizes the read of the 'spelling.txt' and reuses.
--- scripts/checkpatch.pl | 61 +++++++++++++++++++++++++++--------- scripts/deprecated_terms.txt | 5 +++ 2 files changed, 51 insertions(+), 15 deletions(-) create mode 100644 scripts/deprecated_terms.txt
scripts/checkpatch.pl +46 -15
@@ -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,29 +693,41 @@ our $allowed_asm_includes = qr{(?x: )}; # memory.h: ARM has a custom one -# Load common spelling mistakes and build regular expression list. -my $misspellings; -my %spelling_fix; +sub read_word_corrections { + my ($file) = @_; + my $suspects; + my %fixes; -if (open(my $spelling, '<', $spelling_file)) { - while (<$spelling>) { - my $line = $_; + if (open(my $corrections, '<', $file)) { + while (<$corrections>) { + my $line = $_; - $line =~ s/\s*\n?$//g; - $line =~ s/^\s*//g; + $line =~ s/\s*\n?$//g; + $line =~ s/^\s*//g; - next if ($line =~ m/^\s*#/); - next if ($line =~ m/^\s*$/); + next if ($line =~ m/^\s*#/); + next if ($line =~ m/^\s*$/); - my ($suspect, $fix) = split(/\|\|/, $line); + my ($suspect, $fix) = split(/\|\|/, $line); - $spelling_fix{$suspect} = $fix; + $fixes{$suspect} = $fix; + } + close($corrections); + } else { + warn "No correction will be found - file '$file': $!\n"; } - close($spelling); -} else { - warn "No typos will be found - file '$spelling_file': $!\n"; + + return %fixes } +# Load deprecated terms and build regular expression list. +my %deprecated_terms_fix = read_word_corrections($deprecated_terms_file); +my $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 = read_word_corrections($spelling_file); + if ($codespell) { if (open(my $spelling, '<', $codespellfile)) { while (<$spelling>) {
@@ -2957,6 +2970,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)) {
scripts/deprecated_terms.txt new file +5 -0
@@ -0,0 +1,5 @@ +# License: GPLv2 +# +# The format of each line is: +# deprecated||suggested +#
Signature · 1 line
2.17.1
Joe Perches
maintainerRe: Re: [PATCH v3 1/2] checkpatch: support deprecated terms checking
Quoted 1 line · SeongJae Park
On Wed, 10 Jun 2020 00:13:42 -0700 Joe Perches <[email protected]> wrote:
[]
Quoted 4 lines
Quoted 2 lines
This is a direct copy of the spelling dictionary loading code, so maybe these could be consolidated.
Agreed, how about below one?
[]
scripts/checkpatch.pl
Quoted 2 lines
scripts/checkpatch.pl +0
-0
[]
scripts/checkpatch.pl our $allowed_asm_includes = qr{(?x: · line 699
Quoted 4 lines
scripts/checkpatch.pl +4
-0+sub read_word_corrections { + my ($file) = @_; + my $suspects; + my %fixes;
Right.
But I think this should take a hash reference
as the second argument so the complete hash
isn't created and returned.
[]
scripts/checkpatch.pl our $allowed_asm_includes = qr{(?x: · line 724
Quoted 2 lines
scripts/checkpatch.pl +2
-0+# Load deprecated terms and build regular expression list. +my %deprecated_terms_fix = read_word_corrections($deprecated_terms_file);
So this might be something like:
my %deprecated_terms; read_word_corrections($deprecated_terms_file, \%deprecated_terms);
etc...
Re: Re: Re: [PATCH v3 1/2] checkpatch: support deprecated terms checking
Quoted 29 lines · On Wed, 10 Jun 2020 01:45:41 -0700 Joe Perches <[email protected]> wrote:
Quoted 1 line · SeongJae Park
On Wed, 10 Jun 2020 00:13:42 -0700 Joe Perches <[email protected]> wrote:
[]
Quoted 4 lines
Quoted 2 lines
This is a direct copy of the spelling dictionary loading code, so maybe these could be consolidated.
Agreed, how about below one?
[]
scripts/checkpatch.pl
Quoted 2 lines
scripts/checkpatch.pl +0
-0[]
scripts/checkpatch.pl
Quoted 4 lines
scripts/checkpatch.pl +4
-0+sub read_word_corrections { + my ($file) = @_; + my $suspects; + my %fixes;Right.
But I think this should take a hash reference
as the second argument so the complete hash
isn't created and returned.[]
scripts/checkpatch.pl
Quoted 2 lines
scripts/checkpatch.pl +2
-0+# Load deprecated terms and build regular expression list. +my %deprecated_terms_fix = read_word_corrections($deprecated_terms_file);So this might be something like:
Quoted 4 lines
my %deprecated_terms;
read_word_corrections($deprecated_terms_file, \%deprecated_terms);etc...
Appreciate your nice suggestion! So, I updated the patch as below:
================================= >8 ========================================== From 0bcba551f429b0ccec4183437098b3b961d0a724 Mon Sep 17 00:00:00 2001
From: SeongJae Park <[email protected]>
Date: Wed, 10 Jun 2020 07:11:57 +0200
Subject: [PATCH] checkpatch: support deprecated terms checking
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'. For the reason, this commit modularizes the read of the 'spelling.txt' and reuses.
--- scripts/checkpatch.pl | 60 +++++++++++++++++++++++++++--------- scripts/deprecated_terms.txt | 5 +++ 2 files changed, 50 insertions(+), 15 deletions(-) create mode 100644 scripts/deprecated_terms.txt
scripts/checkpatch.pl +45 -15
@@ -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,29 +693,40 @@ our $allowed_asm_includes = qr{(?x: )}; # memory.h: ARM has a custom one -# Load common spelling mistakes and build regular expression list. -my $misspellings; -my %spelling_fix; +sub read_word_corrections { + my ($file, $fixesRef) = @_; + my $suspects; -if (open(my $spelling, '<', $spelling_file)) { - while (<$spelling>) { - my $line = $_; + if (open(my $corrections, '<', $file)) { + while (<$corrections>) { + my $line = $_; - $line =~ s/\s*\n?$//g; - $line =~ s/^\s*//g; + $line =~ s/\s*\n?$//g; + $line =~ s/^\s*//g; - next if ($line =~ m/^\s*#/); - next if ($line =~ m/^\s*$/); + next if ($line =~ m/^\s*#/); + next if ($line =~ m/^\s*$/); - my ($suspect, $fix) = split(/\|\|/, $line); + my ($suspect, $fix) = split(/\|\|/, $line); - $spelling_fix{$suspect} = $fix; + $fixesRef->{$suspect} = $fix; + } + close($corrections); + } else { + warn "No correction will be found - file '$file': $!\n"; } - close($spelling); -} else { - warn "No typos will be found - file '$spelling_file': $!\n"; } +# Load deprecated terms and build regular expression list. +my %deprecated_terms_fix; +read_word_corrections($deprecated_terms_file, \%deprecated_terms_fix); +my $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; +read_word_corrections($spelling_file, \%spelling_fix); + if ($codespell) { if (open(my $spelling, '<', $codespellfile)) { while (<$spelling>) {
@@ -2957,6 +2969,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)) {
scripts/deprecated_terms.txt new file +5 -0
@@ -0,0 +1,5 @@ +# License: GPLv2 +# +# The format of each line is: +# deprecated||suggested +#
Signature · 1 line
2.17.1
PATCH v3 2/2 scripts/deprecated_terms: Recommend blocklist/allowlist instead of blacklist/whitelist
In reply to SeongJae ParkFrom: 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.
--- scripts/deprecated_terms.txt | 2 ++ 1 file changed, 2 insertions(+)
scripts/deprecated_terms.txt +2 -0
@@ -3,3 +3,5 @@ # The format of each line is: # deprecated||suggested # +blacklist||blocklist +whitelist||allowlist
Signature · 1 line
2.17.1
Re: [PATCH v3 2/2] scripts/deprecated_terms: Recommend blocklist/allowlist instead of blacklist/whitelist
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.
--- scripts/deprecated_terms.txt | 2 ++ 1 file changed, 2 insertions(+)
scripts/deprecated_terms.txt +2 -0
@@ -3,3 +3,5 @@ # The format of each line is: # deprecated||suggested # +blacklist||denylist +whitelist||allowlist
Signature · 1 line
2.17.1
Joe Perches
maintainerQuoted 5 lines · SeongJae Park
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.
Quoted 7 lines · SeongJae Park
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
Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek (cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html