Ksummit-Discuss Archive on lore.kernel.org
 help / color / Atom feed
* [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
@ 2020-07-08 18:14 Dan Williams
  2020-07-09  7:25 ` Daniel Vetter
                   ` (9 more replies)
  0 siblings, 10 replies; 23+ messages in thread
From: Dan Williams @ 2020-07-08 18:14 UTC (permalink / raw)
  To: corbet
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

Linux maintains a coding-style and its own idiomatic set of terminology.
Update the style guidelines to recommend replacements for the terms
master/slave and blacklist/whitelist.

Link: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Dave Airlie <airlied@redhat.com>
Acked-by: SeongJae Park <sjpark@amazon.de>
Acked-by: Christian Brauner <christian.brauner@ubuntu.com>
Acked-by: James Bottomley <James.Bottomley@HansenPartnership.com>
Reviewed-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Theodore Ts'o <tytso@mit.edu>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
Signed-off-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Olof Johansson <olof@lixom.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Chris Mason <clm@fb.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Dan Williams <dan.j.williams@intel.com>
---
Changes since v2 [1]:
- Pick up missed sign-offs and acks from Jon, Shuah, and Christian
  (sorry about missing those earlier).

- Reformat the replacement list to make it easier to read.

- Add 'controller' as a suggested replacement (Kees and Mark)

- Fix up the paired term for 'performer' to be 'director' (Kees)

- Collect some new acks, reviewed-by's, and sign-offs for v2.

- Fix up Chris's email

[1]: http://lore.kernel.org/r/159419296487.2464622.863943877093636532.stgit@dwillia2-desk3.amr.corp.intel.com


 Documentation/process/coding-style.rst |   20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
index 2657a55c6f12..1bee6f8affdb 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -319,6 +319,26 @@ If you are afraid to mix up your local variable names, you have another
 problem, which is called the function-growth-hormone-imbalance syndrome.
 See chapter 6 (Functions).
 
+For symbol names and documentation, avoid introducing new usage of
+'master / slave' (or 'slave' independent of 'master') and 'blacklist /
+whitelist'.
+
+Recommended replacements for 'master / slave' are:
+    '{primary,main} / {secondary,replica,subordinate}'
+    '{initiator,requester} / {target,responder}'
+    '{controller,host} / {device,worker,proxy}'
+    'leader / follower'
+    'director / performer'
+
+Recommended replacements for 'blacklist/whitelist' are:
+    'denylist / allowlist'
+    'blocklist / passlist'
+
+Exceptions for introducing new usage is to maintain a userspace ABI/API,
+or when updating code for an existing (as of 2020) hardware or protocol
+specification that mandates those terms. For new specifications
+translate specification usage of the terminology to the kernel coding
+standard where possible.
 
 5) Typedefs
 -----------

_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-08 18:14 [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology Dan Williams
@ 2020-07-09  7:25 ` Daniel Vetter
  2020-07-09 19:08   ` Dan Williams
  2020-07-09  9:45 ` Matthias Brugger
                   ` (8 subsequent siblings)
  9 siblings, 1 reply; 23+ messages in thread
From: Daniel Vetter @ 2020-07-09  7:25 UTC (permalink / raw)
  To: Dan Williams
  Cc: ksummit, Greg Kroah-Hartman, SeongJae Park,
	Linux Kernel Mailing List, tech-board-discuss, James Bottomley,
	Dave Airlie, Christian Brauner, Dan Carpenter

On Wed, Jul 8, 2020 at 8:30 PM Dan Williams <dan.j.williams@intel.com> wrote:
>
> Linux maintains a coding-style and its own idiomatic set of terminology.
> Update the style guidelines to recommend replacements for the terms
> master/slave and blacklist/whitelist.
>
> Link: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Acked-by: Christian Brauner <christian.brauner@ubuntu.com>
> Acked-by: James Bottomley <James.Bottomley@HansenPartnership.com>
> Reviewed-by: Mark Brown <broonie@kernel.org>
> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
> Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
> Signed-off-by: Kees Cook <keescook@chromium.org>
> Signed-off-by: Olof Johansson <olof@lixom.net>
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> Signed-off-by: Chris Mason <clm@fb.com>
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>

Replied to the old version, once more here so it's not lost.

Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>

> ---
> Changes since v2 [1]:
> - Pick up missed sign-offs and acks from Jon, Shuah, and Christian
>   (sorry about missing those earlier).
>
> - Reformat the replacement list to make it easier to read.
>
> - Add 'controller' as a suggested replacement (Kees and Mark)
>
> - Fix up the paired term for 'performer' to be 'director' (Kees)
>
> - Collect some new acks, reviewed-by's, and sign-offs for v2.
>
> - Fix up Chris's email
>
> [1]: http://lore.kernel.org/r/159419296487.2464622.863943877093636532.stgit@dwillia2-desk3.amr.corp.intel.com
>
>
>  Documentation/process/coding-style.rst |   20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
>
> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
> index 2657a55c6f12..1bee6f8affdb 100644
> --- a/Documentation/process/coding-style.rst
> +++ b/Documentation/process/coding-style.rst
> @@ -319,6 +319,26 @@ If you are afraid to mix up your local variable names, you have another
>  problem, which is called the function-growth-hormone-imbalance syndrome.
>  See chapter 6 (Functions).
>
> +For symbol names and documentation, avoid introducing new usage of
> +'master / slave' (or 'slave' independent of 'master') and 'blacklist /
> +whitelist'.
> +
> +Recommended replacements for 'master / slave' are:
> +    '{primary,main} / {secondary,replica,subordinate}'
> +    '{initiator,requester} / {target,responder}'
> +    '{controller,host} / {device,worker,proxy}'
> +    'leader / follower'
> +    'director / performer'
> +
> +Recommended replacements for 'blacklist/whitelist' are:
> +    'denylist / allowlist'
> +    'blocklist / passlist'
> +
> +Exceptions for introducing new usage is to maintain a userspace ABI/API,
> +or when updating code for an existing (as of 2020) hardware or protocol
> +specification that mandates those terms. For new specifications
> +translate specification usage of the terminology to the kernel coding
> +standard where possible.
>
>  5) Typedefs
>  -----------
>
> _______________________________________________
> Ksummit-discuss mailing list
> Ksummit-discuss@lists.linuxfoundation.org
> https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss



-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-08 18:14 [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology Dan Williams
  2020-07-09  7:25 ` Daniel Vetter
@ 2020-07-09  9:45 ` Matthias Brugger
  2020-07-09 19:10   ` Dan Williams
  2020-07-10 21:12 ` Andy Lutomirski
                   ` (7 subsequent siblings)
  9 siblings, 1 reply; 23+ messages in thread
From: Matthias Brugger @ 2020-07-09  9:45 UTC (permalink / raw)
  To: Dan Williams, corbet
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter



On 08/07/2020 20:14, Dan Williams wrote:
> Linux maintains a coding-style and its own idiomatic set of terminology.
> Update the style guidelines to recommend replacements for the terms
> master/slave and blacklist/whitelist.
> 
> Link: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Acked-by: Christian Brauner <christian.brauner@ubuntu.com>
> Acked-by: James Bottomley <James.Bottomley@HansenPartnership.com>
> Reviewed-by: Mark Brown <broonie@kernel.org>
> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
> Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
> Signed-off-by: Kees Cook <keescook@chromium.org>
> Signed-off-by: Olof Johansson <olof@lixom.net>
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> Signed-off-by: Chris Mason <clm@fb.com>
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>

Reviewed-by: Matthias Brugger <matthias.bgg@gmail.com>

> ---
> Changes since v2 [1]:
> - Pick up missed sign-offs and acks from Jon, Shuah, and Christian
>    (sorry about missing those earlier).
> 
> - Reformat the replacement list to make it easier to read.
> 
> - Add 'controller' as a suggested replacement (Kees and Mark)
> 
> - Fix up the paired term for 'performer' to be 'director' (Kees)
> 
> - Collect some new acks, reviewed-by's, and sign-offs for v2.
> 
> - Fix up Chris's email
> 
> [1]: http://lore.kernel.org/r/159419296487.2464622.863943877093636532.stgit@dwillia2-desk3.amr.corp.intel.com
> 
> 
>   Documentation/process/coding-style.rst |   20 ++++++++++++++++++++
>   1 file changed, 20 insertions(+)
> 
> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
> index 2657a55c6f12..1bee6f8affdb 100644
> --- a/Documentation/process/coding-style.rst
> +++ b/Documentation/process/coding-style.rst
> @@ -319,6 +319,26 @@ If you are afraid to mix up your local variable names, you have another
>   problem, which is called the function-growth-hormone-imbalance syndrome.
>   See chapter 6 (Functions).
>   
> +For symbol names and documentation, avoid introducing new usage of
> +'master / slave' (or 'slave' independent of 'master') and 'blacklist /
> +whitelist'.
> +
> +Recommended replacements for 'master / slave' are:
> +    '{primary,main} / {secondary,replica,subordinate}'
> +    '{initiator,requester} / {target,responder}'
> +    '{controller,host} / {device,worker,proxy}'
> +    'leader / follower'
> +    'director / performer'
> +
> +Recommended replacements for 'blacklist/whitelist' are:
> +    'denylist / allowlist'
> +    'blocklist / passlist'
> +
> +Exceptions for introducing new usage is to maintain a userspace ABI/API,
> +or when updating code for an existing (as of 2020) hardware or protocol
> +specification that mandates those terms. For new specifications
> +translate specification usage of the terminology to the kernel coding
> +standard where possible.
>   
>   5) Typedefs
>   -----------
> 
> _______________________________________________
> Ksummit-discuss mailing list
> Ksummit-discuss@lists.linuxfoundation.org
> https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
> 
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-09  7:25 ` Daniel Vetter
@ 2020-07-09 19:08   ` Dan Williams
  0 siblings, 0 replies; 23+ messages in thread
From: Dan Williams @ 2020-07-09 19:08 UTC (permalink / raw)
  To: Daniel Vetter
  Cc: ksummit, Greg Kroah-Hartman, SeongJae Park,
	Linux Kernel Mailing List, tech-board-discuss, James Bottomley,
	Dave Airlie, Christian Brauner, Dan Carpenter

On Thu, Jul 9, 2020 at 12:26 AM Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
>
> On Wed, Jul 8, 2020 at 8:30 PM Dan Williams <dan.j.williams@intel.com> wrote:
> >
> > Linux maintains a coding-style and its own idiomatic set of terminology.
> > Update the style guidelines to recommend replacements for the terms
> > master/slave and blacklist/whitelist.
> >
> > Link: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
> > Acked-by: Randy Dunlap <rdunlap@infradead.org>
> > Acked-by: Dave Airlie <airlied@redhat.com>
> > Acked-by: SeongJae Park <sjpark@amazon.de>
> > Acked-by: Christian Brauner <christian.brauner@ubuntu.com>
> > Acked-by: James Bottomley <James.Bottomley@HansenPartnership.com>
> > Reviewed-by: Mark Brown <broonie@kernel.org>
> > Signed-off-by: Theodore Ts'o <tytso@mit.edu>
> > Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
> > Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
> > Signed-off-by: Kees Cook <keescook@chromium.org>
> > Signed-off-by: Olof Johansson <olof@lixom.net>
> > Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> > Signed-off-by: Chris Mason <clm@fb.com>
> > Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> > Signed-off-by: Dan Williams <dan.j.williams@intel.com>
>
> Replied to the old version, once more here so it's not lost.
>
> Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>

Got it, thanks Daniel.
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-09  9:45 ` Matthias Brugger
@ 2020-07-09 19:10   ` Dan Williams
  0 siblings, 0 replies; 23+ messages in thread
From: Dan Williams @ 2020-07-09 19:10 UTC (permalink / raw)
  To: Matthias Brugger
  Cc: ksummit, Greg Kroah-Hartman, SeongJae Park,
	Linux Kernel Mailing List, tech-board-discuss, James Bottomley,
	Dave Airlie, Christian Brauner, Dan Carpenter

On Thu, Jul 9, 2020 at 2:45 AM Matthias Brugger <mbrugger@suse.com> wrote:
>
>
>
> On 08/07/2020 20:14, Dan Williams wrote:
> > Linux maintains a coding-style and its own idiomatic set of terminology.
> > Update the style guidelines to recommend replacements for the terms
> > master/slave and blacklist/whitelist.
> >
> > Link: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
> > Acked-by: Randy Dunlap <rdunlap@infradead.org>
> > Acked-by: Dave Airlie <airlied@redhat.com>
> > Acked-by: SeongJae Park <sjpark@amazon.de>
> > Acked-by: Christian Brauner <christian.brauner@ubuntu.com>
> > Acked-by: James Bottomley <James.Bottomley@HansenPartnership.com>
> > Reviewed-by: Mark Brown <broonie@kernel.org>
> > Signed-off-by: Theodore Ts'o <tytso@mit.edu>
> > Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
> > Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
> > Signed-off-by: Kees Cook <keescook@chromium.org>
> > Signed-off-by: Olof Johansson <olof@lixom.net>
> > Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> > Signed-off-by: Chris Mason <clm@fb.com>
> > Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> > Signed-off-by: Dan Williams <dan.j.williams@intel.com>
>
> Reviewed-by: Matthias Brugger <matthias.bgg@gmail.com>

Got it, thanks Matthias.
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-08 18:14 [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology Dan Williams
  2020-07-09  7:25 ` Daniel Vetter
  2020-07-09  9:45 ` Matthias Brugger
@ 2020-07-10 21:12 ` Andy Lutomirski
  2020-07-10 21:46   ` Dan Williams
  2020-07-10 21:13 ` Laura Abbott
                   ` (6 subsequent siblings)
  9 siblings, 1 reply; 23+ messages in thread
From: Andy Lutomirski @ 2020-07-10 21:12 UTC (permalink / raw)
  To: Dan Williams
  Cc: ksummit, Greg Kroah-Hartman, SeongJae Park, LKML,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

On Wed, Jul 8, 2020 at 11:30 AM Dan Williams <dan.j.williams@intel.com> wrote:
>
> Linux maintains a coding-style and its own idiomatic set of terminology.
> Update the style guidelines to recommend replacements for the terms
> master/slave and blacklist/whitelist.

Acked-by: Andy Lutomirski <luto@kernel.org>
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-08 18:14 [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology Dan Williams
                   ` (2 preceding siblings ...)
  2020-07-10 21:12 ` Andy Lutomirski
@ 2020-07-10 21:13 ` Laura Abbott
  2020-07-10 21:48   ` Dan Williams
  2020-07-11 20:31 ` josh
                   ` (5 subsequent siblings)
  9 siblings, 1 reply; 23+ messages in thread
From: Laura Abbott @ 2020-07-10 21:13 UTC (permalink / raw)
  To: Dan Williams, corbet
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

On 7/8/20 2:14 PM, Dan Williams wrote:
> Linux maintains a coding-style and its own idiomatic set of terminology.
> Update the style guidelines to recommend replacements for the terms
> master/slave and blacklist/whitelist.
> 
> Link: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Acked-by: Christian Brauner <christian.brauner@ubuntu.com>
> Acked-by: James Bottomley <James.Bottomley@HansenPartnership.com>
> Reviewed-by: Mark Brown <broonie@kernel.org>
> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
> Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
> Signed-off-by: Kees Cook <keescook@chromium.org>
> Signed-off-by: Olof Johansson <olof@lixom.net>
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> Signed-off-by: Chris Mason <clm@fb.com>
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>
> ---
> Changes since v2 [1]:
> - Pick up missed sign-offs and acks from Jon, Shuah, and Christian
>    (sorry about missing those earlier).
> 
> - Reformat the replacement list to make it easier to read.
> 
> - Add 'controller' as a suggested replacement (Kees and Mark)
> 
> - Fix up the paired term for 'performer' to be 'director' (Kees)
> 
> - Collect some new acks, reviewed-by's, and sign-offs for v2.
> 
> - Fix up Chris's email
> 
> [1]: http://lore.kernel.org/r/159419296487.2464622.863943877093636532.stgit@dwillia2-desk3.amr.corp.intel.com
> 
> 
>   Documentation/process/coding-style.rst |   20 ++++++++++++++++++++
>   1 file changed, 20 insertions(+)
> 
> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
> index 2657a55c6f12..1bee6f8affdb 100644
> --- a/Documentation/process/coding-style.rst
> +++ b/Documentation/process/coding-style.rst
> @@ -319,6 +319,26 @@ If you are afraid to mix up your local variable names, you have another
>   problem, which is called the function-growth-hormone-imbalance syndrome.
>   See chapter 6 (Functions).
>   
> +For symbol names and documentation, avoid introducing new usage of
> +'master / slave' (or 'slave' independent of 'master') and 'blacklist /
> +whitelist'.
> +
> +Recommended replacements for 'master / slave' are:
> +    '{primary,main} / {secondary,replica,subordinate}'
> +    '{initiator,requester} / {target,responder}'
> +    '{controller,host} / {device,worker,proxy}'
> +    'leader / follower'
> +    'director / performer'
> +
> +Recommended replacements for 'blacklist/whitelist' are:
> +    'denylist / allowlist'
> +    'blocklist / passlist'
> +
> +Exceptions for introducing new usage is to maintain a userspace ABI/API,
> +or when updating code for an existing (as of 2020) hardware or protocol
> +specification that mandates those terms. For new specifications
> +translate specification usage of the terminology to the kernel coding
> +standard where possible.
>   
>   5) Typedefs
>   -----------
> 

Acked-by: Laura Abbott <laura@labbott.name>
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-10 21:12 ` Andy Lutomirski
@ 2020-07-10 21:46   ` Dan Williams
  0 siblings, 0 replies; 23+ messages in thread
From: Dan Williams @ 2020-07-10 21:46 UTC (permalink / raw)
  To: Andy Lutomirski
  Cc: ksummit, Greg Kroah-Hartman, SeongJae Park, LKML,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

On Fri, Jul 10, 2020 at 2:12 PM Andy Lutomirski <luto@amacapital.net> wrote:
>
> On Wed, Jul 8, 2020 at 11:30 AM Dan Williams <dan.j.williams@intel.com> wrote:
> >
> > Linux maintains a coding-style and its own idiomatic set of terminology.
> > Update the style guidelines to recommend replacements for the terms
> > master/slave and blacklist/whitelist.
>
> Acked-by: Andy Lutomirski <luto@kernel.org>

Thanks, Andy.
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-10 21:13 ` Laura Abbott
@ 2020-07-10 21:48   ` Dan Williams
  0 siblings, 0 replies; 23+ messages in thread
From: Dan Williams @ 2020-07-10 21:48 UTC (permalink / raw)
  To: Laura Abbott
  Cc: ksummit, Greg Kroah-Hartman, SeongJae Park,
	Linux Kernel Mailing List, tech-board-discuss, James Bottomley,
	Dave Airlie, Christian Brauner, Dan Carpenter

On Fri, Jul 10, 2020 at 2:13 PM Laura Abbott <laura@labbott.name> wrote:
>
> On 7/8/20 2:14 PM, Dan Williams wrote:
> > Linux maintains a coding-style and its own idiomatic set of terminology.
> > Update the style guidelines to recommend replacements for the terms
> > master/slave and blacklist/whitelist.
> >
[..]
> Acked-by: Laura Abbott <laura@labbott.name>

Thanks, Laura.
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-08 18:14 [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology Dan Williams
                   ` (3 preceding siblings ...)
  2020-07-10 21:13 ` Laura Abbott
@ 2020-07-11 20:31 ` josh
  2020-07-13  4:20 ` Vinod Koul
                   ` (4 subsequent siblings)
  9 siblings, 0 replies; 23+ messages in thread
From: josh @ 2020-07-11 20:31 UTC (permalink / raw)
  To: Dan Williams
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

On Wed, Jul 08, 2020 at 11:14:27AM -0700, Dan Williams wrote:
> Linux maintains a coding-style and its own idiomatic set of terminology.
> Update the style guidelines to recommend replacements for the terms
> master/slave and blacklist/whitelist.
> 
> Link: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Acked-by: Christian Brauner <christian.brauner@ubuntu.com>
> Acked-by: James Bottomley <James.Bottomley@HansenPartnership.com>
> Reviewed-by: Mark Brown <broonie@kernel.org>
> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
> Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
> Signed-off-by: Kees Cook <keescook@chromium.org>
> Signed-off-by: Olof Johansson <olof@lixom.net>
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> Signed-off-by: Chris Mason <clm@fb.com>
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>

Thank you for working on this, Dan!

Reviewed-by: Josh Triplett <josh@joshtriplett.org>
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-08 18:14 [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology Dan Williams
                   ` (4 preceding siblings ...)
  2020-07-11 20:31 ` josh
@ 2020-07-13  4:20 ` Vinod Koul
  2020-07-13  7:49 ` Joerg Roedel
                   ` (3 subsequent siblings)
  9 siblings, 0 replies; 23+ messages in thread
From: Vinod Koul @ 2020-07-13  4:20 UTC (permalink / raw)
  To: Dan Williams
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

Hi Dan,

On 08-07-20, 11:14, Dan Williams wrote:
> Linux maintains a coding-style and its own idiomatic set of terminology.
> Update the style guidelines to recommend replacements for the terms
> master/slave and blacklist/whitelist.
> 
> Link: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Acked-by: Christian Brauner <christian.brauner@ubuntu.com>
> Acked-by: James Bottomley <James.Bottomley@HansenPartnership.com>
> Reviewed-by: Mark Brown <broonie@kernel.org>
> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
> Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
> Signed-off-by: Kees Cook <keescook@chromium.org>
> Signed-off-by: Olof Johansson <olof@lixom.net>
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> Signed-off-by: Chris Mason <clm@fb.com>
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>

Acked-By: Vinod Koul <vkoul@kernel.org>

Thanks for working on this

> ---
> Changes since v2 [1]:
> - Pick up missed sign-offs and acks from Jon, Shuah, and Christian
>   (sorry about missing those earlier).
> 
> - Reformat the replacement list to make it easier to read.
> 
> - Add 'controller' as a suggested replacement (Kees and Mark)
> 
> - Fix up the paired term for 'performer' to be 'director' (Kees)
> 
> - Collect some new acks, reviewed-by's, and sign-offs for v2.
> 
> - Fix up Chris's email
> 
> [1]: http://lore.kernel.org/r/159419296487.2464622.863943877093636532.stgit@dwillia2-desk3.amr.corp.intel.com
> 
> 
>  Documentation/process/coding-style.rst |   20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
> 
> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
> index 2657a55c6f12..1bee6f8affdb 100644
> --- a/Documentation/process/coding-style.rst
> +++ b/Documentation/process/coding-style.rst
> @@ -319,6 +319,26 @@ If you are afraid to mix up your local variable names, you have another
>  problem, which is called the function-growth-hormone-imbalance syndrome.
>  See chapter 6 (Functions).
>  
> +For symbol names and documentation, avoid introducing new usage of
> +'master / slave' (or 'slave' independent of 'master') and 'blacklist /
> +whitelist'.
> +
> +Recommended replacements for 'master / slave' are:
> +    '{primary,main} / {secondary,replica,subordinate}'
> +    '{initiator,requester} / {target,responder}'
> +    '{controller,host} / {device,worker,proxy}'
> +    'leader / follower'
> +    'director / performer'
> +
> +Recommended replacements for 'blacklist/whitelist' are:
> +    'denylist / allowlist'
> +    'blocklist / passlist'
> +
> +Exceptions for introducing new usage is to maintain a userspace ABI/API,
> +or when updating code for an existing (as of 2020) hardware or protocol
> +specification that mandates those terms. For new specifications
> +translate specification usage of the terminology to the kernel coding
> +standard where possible.
>  
>  5) Typedefs
>  -----------
> 
> _______________________________________________
> Ksummit-discuss mailing list
> Ksummit-discuss@lists.linuxfoundation.org
> https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

-- 
~Vinod
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-08 18:14 [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology Dan Williams
                   ` (5 preceding siblings ...)
  2020-07-13  4:20 ` Vinod Koul
@ 2020-07-13  7:49 ` Joerg Roedel
  2020-07-13  8:02 ` Takashi Iwai
                   ` (2 subsequent siblings)
  9 siblings, 0 replies; 23+ messages in thread
From: Joerg Roedel @ 2020-07-13  7:49 UTC (permalink / raw)
  To: Dan Williams
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

On Wed, Jul 08, 2020 at 11:14:27AM -0700, Dan Williams wrote:
> Linux maintains a coding-style and its own idiomatic set of terminology.
> Update the style guidelines to recommend replacements for the terms
> master/slave and blacklist/whitelist.

Acked-by: Joerg Roedel <jroedel@suse.de>

_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-08 18:14 [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology Dan Williams
                   ` (6 preceding siblings ...)
  2020-07-13  7:49 ` Joerg Roedel
@ 2020-07-13  8:02 ` Takashi Iwai
  2020-07-13  8:43   ` Julia Lawall
                     ` (3 more replies)
  2020-07-15 12:19 ` Jani Nikula
  2020-07-17  8:36 ` Pavel Machek
  9 siblings, 4 replies; 23+ messages in thread
From: Takashi Iwai @ 2020-07-13  8:02 UTC (permalink / raw)
  To: Dan Williams
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

On Wed, 08 Jul 2020 20:14:27 +0200,
Dan Williams wrote:
> 
> +Recommended replacements for 'blacklist/whitelist' are:
> +    'denylist / allowlist'
> +    'blocklist / passlist'

I started looking through the tree now and noticed there are lots of
patterns like "whitelisted" or "blacklisted".  How can the words fit
for those?  Actually, there are two cases like:

- Foo is blacklisted
- Allow to load the non-whitelisted cards

Currently I'm replacing the former with "Foo is in denylist", but not
sure about the latter case.  I thought Kees mentioned about this, but
don't remember the proposal...

In anyway, I'm for the action:
  Acked-by: Takashi Iwai <tiwai@suse.de>


thanks,

Takashi
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-13  8:02 ` Takashi Iwai
@ 2020-07-13  8:43   ` Julia Lawall
  2020-07-13  9:36     ` Takashi Iwai
  2020-07-13 15:06   ` [Ksummit-discuss] [Tech-board-discuss] " James Bottomley
                     ` (2 subsequent siblings)
  3 siblings, 1 reply; 23+ messages in thread
From: Julia Lawall @ 2020-07-13  8:43 UTC (permalink / raw)
  To: Takashi Iwai
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter



On Mon, 13 Jul 2020, Takashi Iwai wrote:

> On Wed, 08 Jul 2020 20:14:27 +0200,
> Dan Williams wrote:
> >
> > +Recommended replacements for 'blacklist/whitelist' are:
> > +    'denylist / allowlist'
> > +    'blocklist / passlist'
>
> I started looking through the tree now and noticed there are lots of
> patterns like "whitelisted" or "blacklisted".  How can the words fit
> for those?  Actually, there are two cases like:
>
> - Foo is blacklisted
> - Allow to load the non-whitelisted cards
>
> Currently I'm replacing the former with "Foo is in denylist", but not

In the denylist?

julia


> sure about the latter case.  I thought Kees mentioned about this, but
> don't remember the proposal...
>
> In anyway, I'm for the action:
>   Acked-by: Takashi Iwai <tiwai@suse.de>
>
>
> thanks,
>
> Takashi
> _______________________________________________
> Ksummit-discuss mailing list
> Ksummit-discuss@lists.linuxfoundation.org
> https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
>
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-13  8:43   ` Julia Lawall
@ 2020-07-13  9:36     ` Takashi Iwai
  2020-07-13  9:39       ` Julia Lawall
  0 siblings, 1 reply; 23+ messages in thread
From: Takashi Iwai @ 2020-07-13  9:36 UTC (permalink / raw)
  To: Julia Lawall
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

On Mon, 13 Jul 2020 10:43:28 +0200,
Julia Lawall wrote:
> 
> 
> 
> On Mon, 13 Jul 2020, Takashi Iwai wrote:
> 
> > On Wed, 08 Jul 2020 20:14:27 +0200,
> > Dan Williams wrote:
> > >
> > > +Recommended replacements for 'blacklist/whitelist' are:
> > > +    'denylist / allowlist'
> > > +    'blocklist / passlist'
> >
> > I started looking through the tree now and noticed there are lots of
> > patterns like "whitelisted" or "blacklisted".  How can the words fit
> > for those?  Actually, there are two cases like:
> >
> > - Foo is blacklisted
> > - Allow to load the non-whitelisted cards
> >
> > Currently I'm replacing the former with "Foo is in denylist", but not
> 
> In the denylist?

Not really, only the allowlist exists in this case.


thanks,

Takashi
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-13  9:36     ` Takashi Iwai
@ 2020-07-13  9:39       ` Julia Lawall
  2020-07-13  9:44         ` Takashi Iwai
  0 siblings, 1 reply; 23+ messages in thread
From: Julia Lawall @ 2020-07-13  9:39 UTC (permalink / raw)
  To: Takashi Iwai
  Cc: James Bottomley, ksummit-discuss, Greg Kroah-Hartman,
	SeongJae Park, linux-kernel, tech-board-discuss, Dave Airlie,
	Christian Brauner, Dan Carpenter



On Mon, 13 Jul 2020, Takashi Iwai wrote:

> On Mon, 13 Jul 2020 10:43:28 +0200,
> Julia Lawall wrote:
> >
> >
> >
> > On Mon, 13 Jul 2020, Takashi Iwai wrote:
> >
> > > On Wed, 08 Jul 2020 20:14:27 +0200,
> > > Dan Williams wrote:
> > > >
> > > > +Recommended replacements for 'blacklist/whitelist' are:
> > > > +    'denylist / allowlist'
> > > > +    'blocklist / passlist'
> > >
> > > I started looking through the tree now and noticed there are lots of
> > > patterns like "whitelisted" or "blacklisted".  How can the words fit
> > > for those?  Actually, there are two cases like:
> > >
> > > - Foo is blacklisted
> > > - Allow to load the non-whitelisted cards
> > >
> > > Currently I'm replacing the former with "Foo is in denylist", but not
> >
> > In the denylist?
>
> Not really, only the allowlist exists in this case.

I'm not sure to understand.  in denylist is not grammatical.  It needs "a"
or "the".

Maybe it has to be foo is denylisted?  foo is in the implicit denyList?
foo is not in the allowList?

julia
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-13  9:39       ` Julia Lawall
@ 2020-07-13  9:44         ` Takashi Iwai
  0 siblings, 0 replies; 23+ messages in thread
From: Takashi Iwai @ 2020-07-13  9:44 UTC (permalink / raw)
  To: Julia Lawall
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

On Mon, 13 Jul 2020 11:39:56 +0200,
Julia Lawall wrote:
> 
> 
> 
> On Mon, 13 Jul 2020, Takashi Iwai wrote:
> 
> > On Mon, 13 Jul 2020 10:43:28 +0200,
> > Julia Lawall wrote:
> > >
> > >
> > >
> > > On Mon, 13 Jul 2020, Takashi Iwai wrote:
> > >
> > > > On Wed, 08 Jul 2020 20:14:27 +0200,
> > > > Dan Williams wrote:
> > > > >
> > > > > +Recommended replacements for 'blacklist/whitelist' are:
> > > > > +    'denylist / allowlist'
> > > > > +    'blocklist / passlist'
> > > >
> > > > I started looking through the tree now and noticed there are lots of
> > > > patterns like "whitelisted" or "blacklisted".  How can the words fit
> > > > for those?  Actually, there are two cases like:
> > > >
> > > > - Foo is blacklisted
> > > > - Allow to load the non-whitelisted cards
> > > >
> > > > Currently I'm replacing the former with "Foo is in denylist", but not
> > >
> > > In the denylist?
> >
> > Not really, only the allowlist exists in this case.
> 
> I'm not sure to understand.  in denylist is not grammatical.  It needs "a"
> or "the".

Ah, now I see how I confused you.  The two cases I mentioned in the
above are completely individual.  They were found in two different
drivers.  I put those just as two distinct examples for the passive
form usages.  Sorry for unclearness.

What I meant about the latter was that "not in allowlist" doesn't mean
it being "in denylist".  It's simply unknown.


Takashi
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [Tech-board-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-13  8:02 ` Takashi Iwai
  2020-07-13  8:43   ` Julia Lawall
@ 2020-07-13 15:06   ` James Bottomley
  2020-07-14  4:39   ` [Ksummit-discuss] " josh
  2020-07-17 16:47   ` Andy Lutomirski
  3 siblings, 0 replies; 23+ messages in thread
From: James Bottomley @ 2020-07-13 15:06 UTC (permalink / raw)
  To: Takashi Iwai, Dan Williams
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, Dave Airlie, Christian Brauner,
	Dan Carpenter

On Mon, 2020-07-13 at 10:02 +0200, Takashi Iwai wrote:
> On Wed, 08 Jul 2020 20:14:27 +0200,
> Dan Williams wrote:
> > 
> > +Recommended replacements for 'blacklist/whitelist' are:
> > +    'denylist / allowlist'
> > +    'blocklist / passlist'
> 
> I started looking through the tree now and noticed there are lots of
> patterns like "whitelisted" or "blacklisted".  How can the words fit
> for those?  Actually, there are two cases like:
> 
> - Foo is blacklisted
> - Allow to load the non-whitelisted cards
> 
> Currently I'm replacing the former with "Foo is in denylist", but not
> sure about the latter case.  I thought Kees mentioned about this, but
> don't remember the proposal...

Remember these are suggestions for going forwards, not requirements for
changing everything.  We tend to be a community that likes make work
projects because they're easier to do than solving the hard problems,
but since we have over 100k occurrences of the various words in the
kernel, changing them all would cause massive churn and disrupt forward
development, which would cause way more harm than any gain from the
change.

James



_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-13  8:02 ` Takashi Iwai
  2020-07-13  8:43   ` Julia Lawall
  2020-07-13 15:06   ` [Ksummit-discuss] [Tech-board-discuss] " James Bottomley
@ 2020-07-14  4:39   ` josh
  2020-07-14  6:43     ` Takashi Iwai
  2020-07-17 16:47   ` Andy Lutomirski
  3 siblings, 1 reply; 23+ messages in thread
From: josh @ 2020-07-14  4:39 UTC (permalink / raw)
  To: Takashi Iwai
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

On Mon, Jul 13, 2020 at 10:02:24AM +0200, Takashi Iwai wrote:
> On Wed, 08 Jul 2020 20:14:27 +0200,
> Dan Williams wrote:
> > 
> > +Recommended replacements for 'blacklist/whitelist' are:
> > +    'denylist / allowlist'
> > +    'blocklist / passlist'
> 
> I started looking through the tree now and noticed there are lots of
> patterns like "whitelisted" or "blacklisted".  How can the words fit
> for those?  Actually, there are two cases like:
> 
> - Foo is blacklisted
> - Allow to load the non-whitelisted cards
> 
> Currently I'm replacing the former with "Foo is in denylist", but not
> sure about the latter case.  I thought Kees mentioned about this, but
> don't remember the proposal...

I find that "blocklist" works well as a verb: "foo is blocklisted",
"blocklist foo", or in some cases just "block foo" or "deny foo". For
the second case, phrasings like "allow loading non-safelisted cards" or
"allow loading cards not on the passlist" seem clear.
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-14  4:39   ` [Ksummit-discuss] " josh
@ 2020-07-14  6:43     ` Takashi Iwai
  0 siblings, 0 replies; 23+ messages in thread
From: Takashi Iwai @ 2020-07-14  6:43 UTC (permalink / raw)
  To: josh
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

On Tue, 14 Jul 2020 06:39:49 +0200,
josh@joshtriplett.org wrote:
> 
> On Mon, Jul 13, 2020 at 10:02:24AM +0200, Takashi Iwai wrote:
> > On Wed, 08 Jul 2020 20:14:27 +0200,
> > Dan Williams wrote:
> > > 
> > > +Recommended replacements for 'blacklist/whitelist' are:
> > > +    'denylist / allowlist'
> > > +    'blocklist / passlist'
> > 
> > I started looking through the tree now and noticed there are lots of
> > patterns like "whitelisted" or "blacklisted".  How can the words fit
> > for those?  Actually, there are two cases like:
> > 
> > - Foo is blacklisted
> > - Allow to load the non-whitelisted cards
> > 
> > Currently I'm replacing the former with "Foo is in denylist", but not
> > sure about the latter case.  I thought Kees mentioned about this, but
> > don't remember the proposal...
> 
> I find that "blocklist" works well as a verb: "foo is blocklisted",
> "blocklist foo", or in some cases just "block foo" or "deny foo". For
> the second case, phrasings like "allow loading non-safelisted cards" or
> "allow loading cards not on the passlist" seem clear.

Yes, that makes sense.  I have wished some simple replacement with
sed, but it seems that it'd be better to rephrase such texts in
anyway.


thanks,

Takashi

_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-08 18:14 [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology Dan Williams
                   ` (7 preceding siblings ...)
  2020-07-13  8:02 ` Takashi Iwai
@ 2020-07-15 12:19 ` Jani Nikula
  2020-07-17  8:36 ` Pavel Machek
  9 siblings, 0 replies; 23+ messages in thread
From: Jani Nikula @ 2020-07-15 12:19 UTC (permalink / raw)
  To: Dan Williams, corbet
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

On Wed, 08 Jul 2020, Dan Williams <dan.j.williams@intel.com> wrote:
> Linux maintains a coding-style and its own idiomatic set of terminology.
> Update the style guidelines to recommend replacements for the terms
> master/slave and blacklist/whitelist.
>
> Link: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Acked-by: Christian Brauner <christian.brauner@ubuntu.com>
> Acked-by: James Bottomley <James.Bottomley@HansenPartnership.com>
> Reviewed-by: Mark Brown <broonie@kernel.org>
> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
> Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
> Signed-off-by: Kees Cook <keescook@chromium.org>
> Signed-off-by: Olof Johansson <olof@lixom.net>
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> Signed-off-by: Chris Mason <clm@fb.com>
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>

FWIW,

Acked-by: Jani Nikula <jani.nikula@intel.com>

> ---
> Changes since v2 [1]:
> - Pick up missed sign-offs and acks from Jon, Shuah, and Christian
>   (sorry about missing those earlier).
>
> - Reformat the replacement list to make it easier to read.
>
> - Add 'controller' as a suggested replacement (Kees and Mark)
>
> - Fix up the paired term for 'performer' to be 'director' (Kees)
>
> - Collect some new acks, reviewed-by's, and sign-offs for v2.
>
> - Fix up Chris's email
>
> [1]: http://lore.kernel.org/r/159419296487.2464622.863943877093636532.stgit@dwillia2-desk3.amr.corp.intel.com
>
>
>  Documentation/process/coding-style.rst |   20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
>
> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
> index 2657a55c6f12..1bee6f8affdb 100644
> --- a/Documentation/process/coding-style.rst
> +++ b/Documentation/process/coding-style.rst
> @@ -319,6 +319,26 @@ If you are afraid to mix up your local variable names, you have another
>  problem, which is called the function-growth-hormone-imbalance syndrome.
>  See chapter 6 (Functions).
>  
> +For symbol names and documentation, avoid introducing new usage of
> +'master / slave' (or 'slave' independent of 'master') and 'blacklist /
> +whitelist'.
> +
> +Recommended replacements for 'master / slave' are:
> +    '{primary,main} / {secondary,replica,subordinate}'
> +    '{initiator,requester} / {target,responder}'
> +    '{controller,host} / {device,worker,proxy}'
> +    'leader / follower'
> +    'director / performer'
> +
> +Recommended replacements for 'blacklist/whitelist' are:
> +    'denylist / allowlist'
> +    'blocklist / passlist'
> +
> +Exceptions for introducing new usage is to maintain a userspace ABI/API,
> +or when updating code for an existing (as of 2020) hardware or protocol
> +specification that mandates those terms. For new specifications
> +translate specification usage of the terminology to the kernel coding
> +standard where possible.
>  
>  5) Typedefs
>  -----------
>
> _______________________________________________
> Ksummit-discuss mailing list
> Ksummit-discuss@lists.linuxfoundation.org
> https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

-- 
Jani Nikula, Intel Open Source Graphics Center
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-08 18:14 [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology Dan Williams
                   ` (8 preceding siblings ...)
  2020-07-15 12:19 ` Jani Nikula
@ 2020-07-17  8:36 ` Pavel Machek
  9 siblings, 0 replies; 23+ messages in thread
From: Pavel Machek @ 2020-07-17  8:36 UTC (permalink / raw)
  To: Dan Williams
  Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

On Wed 2020-07-08 11:14:27, Dan Williams wrote:
> Linux maintains a coding-style and its own idiomatic set of terminology.
> Update the style guidelines to recommend replacements for the terms
> master/slave and blacklist/whitelist.
> 
> Link: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Acked-by: Christian Brauner <christian.brauner@ubuntu.com>
> Acked-by: James Bottomley <James.Bottomley@HansenPartnership.com>
> Reviewed-by: Mark Brown <broonie@kernel.org>
> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
> Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
> Signed-off-by: Kees Cook <keescook@chromium.org>
> Signed-off-by: Olof Johansson <olof@lixom.net>
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> Signed-off-by: Chris Mason <clm@fb.com>
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>
> ---
> Changes since v2 [1]:
> - Pick up missed sign-offs and acks from Jon, Shuah, and Christian
>   (sorry about missing those earlier).
> 
> - Reformat the replacement list to make it easier to read.
> 
> - Add 'controller' as a suggested replacement (Kees and Mark)
> 
> - Fix up the paired term for 'performer' to be 'director' (Kees)
> 
> - Collect some new acks, reviewed-by's, and sign-offs for v2.
> 
> - Fix up Chris's email
> 
> [1]: http://lore.kernel.org/r/159419296487.2464622.863943877093636532.stgit@dwillia2-desk3.amr.corp.intel.com
> 
> 
>  Documentation/process/coding-style.rst |   20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
> 
> +Recommended replacements for 'blacklist/whitelist' are: + 'denylist / allowlist' + 
> 'blocklist / passlist' + +Exceptions for introducing new usage is to maintain a 
> userspace ABI/API, +or when updating code for an existing (as of 2020) hardware or 
> protocol +specification that mandates those terms. For new specifications +translate 
> specification usage of the terminology to the kernel coding +standard where possible.

Please try to understand how "blacklist" is used in the kernel before suggesting replacements.

NAK.
									Pavel

-- 
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology
  2020-07-13  8:02 ` Takashi Iwai
                     ` (2 preceding siblings ...)
  2020-07-14  4:39   ` [Ksummit-discuss] " josh
@ 2020-07-17 16:47   ` Andy Lutomirski
  3 siblings, 0 replies; 23+ messages in thread
From: Andy Lutomirski @ 2020-07-17 16:47 UTC (permalink / raw)
  To: Takashi Iwai
  Cc: ksummit, Greg Kroah-Hartman, SeongJae Park, LKML,
	tech-board-discuss, James Bottomley, Dave Airlie,
	Christian Brauner, Dan Carpenter

On Mon, Jul 13, 2020 at 1:02 AM Takashi Iwai <tiwai@suse.de> wrote:
>
> On Wed, 08 Jul 2020 20:14:27 +0200,
> Dan Williams wrote:
> >
> > +Recommended replacements for 'blacklist/whitelist' are:
> > +    'denylist / allowlist'
> > +    'blocklist / passlist'
>
> I started looking through the tree now and noticed there are lots of
> patterns like "whitelisted" or "blacklisted".  How can the words fit
> for those?  Actually, there are two cases like:
>
> - Foo is blacklisted
> - Allow to load the non-whitelisted cards
>
> Currently I'm replacing the former with "Foo is in denylist", but not
> sure about the latter case.  I thought Kees mentioned about this, but
> don't remember the proposal...

Hmm.  In these cases, we're trying to convey one of two things.  A
given device/platform/CPU/whatever could be known to be problematic
and thus disallowed, or we could have a policy that we generally don't
trust hardware but we have specific reason to believe that this
particular hardware is okay.  After doing a highly scientific sampling
of a few cases, some of these are indeed lists and some are not.

If we're going to look for new words for these concepts, perhaps we
shouldn't focus on the *list* aspect -- after all, that's just a
rather popular implementation detail, but it's not the core concept
we're trying to express.  As an example case, we have a horrible
concept in which some Intel CPUs support a form of memory failure
recovery, and there is no enumeration mechanism.  Instead, there's a
list (sigh).  So we could say "your CPU is whitelisted for
such-and-such," which at least gets the idea across, but saying "your
CPU is allowlisted for such-and-such" seems like a stretch.  It's not
that we have a policy to allow things on the list -- it's that we
think that CPUs not on the list simply don't have the relevant
capability.

Here are some brainstormed ideas:

 - Such-and-such feature is quirked off.  (Or disabled due to a quirk.)

 - Your device is not on the known-good list.

 - Your device is not known-good.  It might work anyway -- to try it,
set such-and-such option.

 - Your device is known bad.

 - Your device is busted and we think you should pressure the
manufacturer to fix it.

 - Your device is too old and no longer supported.

 - Seriously, you're trying to use an 80386 on a modern kernel?  No
thanks.  We think it's neat that you still have one that works,
though.

 - (Specifically for modules and not part of the Linux kernel tree)
disable_autoload instead of blacklist, perhaps?

Part of my point is that we use blacklist and whitelist to mean
various things, and I don't think we should try to invent a couple of
new catch-all terms to replace them.  Perhaps replacing these words
could be an opportunity to come up with better descriptions at the
same time.
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

^ permalink raw reply	[flat|nested] 23+ messages in thread

end of thread, back to index

Thread overview: 23+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-08 18:14 [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology Dan Williams
2020-07-09  7:25 ` Daniel Vetter
2020-07-09 19:08   ` Dan Williams
2020-07-09  9:45 ` Matthias Brugger
2020-07-09 19:10   ` Dan Williams
2020-07-10 21:12 ` Andy Lutomirski
2020-07-10 21:46   ` Dan Williams
2020-07-10 21:13 ` Laura Abbott
2020-07-10 21:48   ` Dan Williams
2020-07-11 20:31 ` josh
2020-07-13  4:20 ` Vinod Koul
2020-07-13  7:49 ` Joerg Roedel
2020-07-13  8:02 ` Takashi Iwai
2020-07-13  8:43   ` Julia Lawall
2020-07-13  9:36     ` Takashi Iwai
2020-07-13  9:39       ` Julia Lawall
2020-07-13  9:44         ` Takashi Iwai
2020-07-13 15:06   ` [Ksummit-discuss] [Tech-board-discuss] " James Bottomley
2020-07-14  4:39   ` [Ksummit-discuss] " josh
2020-07-14  6:43     ` Takashi Iwai
2020-07-17 16:47   ` Andy Lutomirski
2020-07-15 12:19 ` Jani Nikula
2020-07-17  8:36 ` Pavel Machek

Ksummit-Discuss Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/ksummit-discuss/0 ksummit-discuss/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 ksummit-discuss ksummit-discuss/ https://lore.kernel.org/ksummit-discuss \
		ksummit-discuss@lists.linuxfoundation.org
	public-inbox-index ksummit-discuss

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.linuxfoundation.lists.ksummit-discuss


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git