Maintenance: Start following Inclusive Naming Initiative advice (#786)

... as detailed at https://inclusivenaming.org/

This change is limited to the words "whitelist" and "blacklist". Those
two words are easier to replace with, arguably, better ones.

No functionality changes.

diff --git a/doc/release-notes/release-3.4.sgml b/doc/release-notes/release-3.4.sgml
index 6360fa6dd592bc1bd2d5ae0e151273e6125f0a9c..446fc85cf91a2be0810a304dbd341b1478cfc092 100644 (file)
--- a/doc/release-notes/release-3.4.sgml
+++ b/doc/release-notes/release-3.4.sgml
@@ -204,7 +204,7 @@ There have been changes to Squid's configuration file since Squid-3.3.
 <p>Squid supports reading configuration option parameters from external
    files using the syntax <em>parameters("/path/filename")</em>. For example:
 <verb>
-    acl whitelist dstdomain parameters("/etc/squid/whitelist.txt")
+    acl allowlist dstdomain parameters("/etc/squid/allowlist.txt")
 </verb>
 
 <p>There have also been changes to individual directives in the config file.

diff --git a/doc/release-notes/release-3.5.sgml b/doc/release-notes/release-3.5.sgml
index 60033cb3d21ea94a919842481d5344409e90b359..46517adb829eb8bd9815e9700c7969f00c628ea4 100644 (file)
--- a/doc/release-notes/release-3.5.sgml
+++ b/doc/release-notes/release-3.5.sgml
@@ -245,7 +245,7 @@ Most user-facing changes are reflected in squid.conf (see below).
 
 <p>Squid can be configured by adding an <em>http_port</em>
    with the <em>require-proxy-header</em> mode flag. The <em>proxy_protocol_access</em>
-   must also be configured with <em>src</em> ACLs to whitelist proxies which are
+   must also be configured with <em>src</em> ACLs to permit proxies which are
    trusted to send correct client details.
 
 <p>Forward-proxy traffic from a client proxy:
@@ -310,7 +310,7 @@ There have been changes to Squid's configuration file since Squid-3.4.
 <p>Squid supports reading configuration option parameters from external
    files using the syntax <em>parameters("/path/filename")</em>. For example:
 <verb>
-    acl whitelist dstdomain parameters("/etc/squid/whitelist.txt")
+    acl allowlist dstdomain parameters("/etc/squid/allowlist.txt")
 </verb>
 
 <p>The squid.conf macro <em>${service_name}</em> is added to provide the service name

diff --git a/scripts/codespell-whitelist.txt b/scripts/codespell-ignorelist.txt
similarity index 100%
rename from scripts/codespell-whitelist.txt
rename to scripts/codespell-ignorelist.txt

diff --git a/scripts/spell-check.sh b/scripts/spell-check.sh
index c313eb6201df0f45463a59a3154a2b180ffad7ec..c3fa76a3052f3bdeab78b8dc5f2d71f87bbc1119 100755 (executable)
--- a/scripts/spell-check.sh
+++ b/scripts/spell-check.sh
@@ -16,7 +16,7 @@
 #
 # By default, a hand-picked subset of Squid repository sources is fixed.
 #
-# See ${WHITE_LIST} below for the list of allowed misspellings.
+# See ${ALLOW_LIST} below for the list of allowed misspellings.
 #
 
 set -e
@@ -33,9 +33,9 @@ if ! git diff --quiet; then
     exit 1
 fi
 
-WHITE_LIST=scripts/codespell-whitelist.txt
-if test ! -f "${WHITE_LIST}"; then
-    echo "${WHITE_LIST} does not exist"
+IGNORE_LIST=scripts/codespell-ignorelist.txt
+if test ! -f "${IGNORE_LIST}"; then
+    echo "${IGNORE_LIST} does not exist"
     exit 1
 fi
 
@@ -62,7 +62,7 @@ for FILENAME in `git ls-files "$@"`; do
     *.sql|\
     errors/templates/ERR_*|\
     INSTALL|README|QUICKSTART)
-        if ! codespell -d -q 3 -w -I "${WHITE_LIST}" ${FILENAME}; then
+        if ! codespell -d -q 3 -w -I "${IGNORE_LIST}" ${FILENAME}; then
             echo "codespell failed for ${FILENAME}"
             exit 1
        fi

diff --git a/src/Notes.cc b/src/Notes.cc
index 78b3b03f154afec11e8b6c46cd5ebf1a133d77c6..22d99abcf1039ca20f09c5e5295178f68d58fbd7 100644 (file)
--- a/src/Notes.cc
+++ b/src/Notes.cc
@@ -126,7 +126,7 @@ Note::toString(const char *sep) const
 }
 
 const Notes::Keys &
-Notes::BlackList()
+Notes::ReservedKeys()
 {
     // these keys are used for internal Squid-helper communication
     static const char *names[] = {
@@ -147,12 +147,12 @@ Notes::BlackList()
     return keys;
 }
 
-Notes::Notes(const char *aDescr, const Keys *extraBlacklist, bool allowFormatted):
+Notes::Notes(const char *aDescr, const Keys *extraReservedKeys, bool allowFormatted):
     descr(aDescr),
     formattedValues(allowFormatted)
 {
-    if (extraBlacklist)
-        blacklist = *extraBlacklist;
+    if (extraReservedKeys)
+        reservedKeys = *extraReservedKeys;
 }
 
 Note::Pointer
@@ -183,8 +183,8 @@ Notes::banReservedKey(const SBuf &key, const Keys &banned) const
 void
 Notes::validateKey(const SBuf &key) const
 {
-    banReservedKey(key, BlackList());
-    banReservedKey(key, blacklist);
+    banReservedKey(key, ReservedKeys());
+    banReservedKey(key, reservedKeys);
 
     // TODO: fix code duplication: the same set of specials is produced
     // by isKeyNameChar().

diff --git a/src/Notes.h b/src/Notes.h
index 6920de270f0bfe2054be2e9c7ee6e27c2dfe4ce3..2043a9d0be1499324a161b622c4753c93c069a51 100644 (file)
--- a/src/Notes.h
+++ b/src/Notes.h
@@ -114,7 +114,7 @@ public:
     typedef NotesList::iterator iterator; ///< iterates over the notes list
     typedef NotesList::const_iterator const_iterator; ///< iterates over the notes list
 
-    explicit Notes(const char *aDescr, const Keys *extraBlacklist = nullptr, bool allowFormatted = true);
+    explicit Notes(const char *aDescr, const Keys *extraReservedKeys = nullptr, bool allowFormatted = true);
     Notes() = default;
     ~Notes() { notes.clear(); }
     Notes(const Notes&) = delete;
@@ -146,7 +146,7 @@ private:
     /// Makes sure the given key is not on the given list of banned names.
     void banReservedKey(const SBuf &key, const Keys &banned) const;
 
-    /// Verifies that the key is not blacklisted (fatal error) and
+    /// Verifies that the key is not reserved (fatal error) and
     /// does not contain special characters (non-fatal error).
     void validateKey(const SBuf &key) const;
 
@@ -160,10 +160,10 @@ private:
     NotesList notes; ///< The Note::Pointer objects array list
     const char *descr = nullptr; ///< identifies note source in error messages
 
-    Keys blacklist; ///< a list of additional prohibited key names
+    Keys reservedKeys; ///< a list of additional prohibited key names
     bool formattedValues = false; ///< whether to expand quoted logformat %codes
 
-    static const Notes::Keys &BlackList(); ///< always prohibited key names
+    static const Notes::Keys &ReservedKeys(); ///< always prohibited key names
 };
 
 /**

diff --git a/src/cf.data.pre b/src/cf.data.pre
index 397170b0a5b947ef196e591bd357bdcd68e7fe47..cae249afadb479034a239842c669df7555dc6e34 100644 (file)
--- a/src/cf.data.pre
+++ b/src/cf.data.pre
@@ -84,7 +84,7 @@ COMMENT_START
        files using the syntax:
                parameters("/path/filename")
        For example:
-               acl whitelist dstdomain parameters("/etc/squid/whitelist.txt")
+               acl allowlist dstdomain parameters("/etc/squid/allowlist.txt")
 
   Conditional configuration
 
@@ -2455,7 +2455,7 @@ DOC_START
 
           require-proxy-header
                        Require PROXY protocol version 1 or 2 connections.
-                       The proxy_protocol_access is required to whitelist
+                       The proxy_protocol_access is required to permit
                        downstream proxies which can be trusted.
 
           worker-queues

diff --git a/src/servers/FtpServer.cc b/src/servers/FtpServer.cc
index 549f1aac8882d0ea26f2a7035260fa055c129119..099102fffbaaad2e04c6e62d1ac291ec3631bb65 100644 (file)
--- a/src/servers/FtpServer.cc
+++ b/src/servers/FtpServer.cc
@@ -1834,16 +1834,16 @@ void Ftp::Server::completeDataDownload()
 static bool
 Ftp::SupportedCommand(const SBuf &name)
 {
-    static std::set<SBuf> BlackList;
-    if (BlackList.empty()) {
+    static std::set<SBuf> BlockList;
+    if (BlockList.empty()) {
         /* Add FTP commands that Squid cannot relay correctly. */
 
         // We probably do not support AUTH TLS.* and AUTH SSL,
         // but let's disclaim all AUTH support to KISS, for now.
-        BlackList.insert(cmdAuth());
+        BlockList.insert(cmdAuth());
     }
 
     // we claim support for all commands that we do not know about
-    return BlackList.find(name) == BlackList.end();
+    return BlockList.find(name) == BlockList.end();
 }