* [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
@ 2020-07-08 7:23 Dan Williams
2020-07-08 7:52 ` Dan Williams
` (10 more replies)
0 siblings, 11 replies; 16+ messages in thread
From: Dan Williams @ 2020-07-08 7:23 UTC (permalink / raw)
To: corbet
Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
tech-board-discuss, Chris Mason, Dave Airlie
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
Cc: Jonathan Corbet <corbet@lwn.net>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Dave Airlie <airlied@redhat.com>
Acked-by: Kees Cook <keescook@chromium.org>
Acked-by: SeongJae Park <sjpark@amazon.de>
Signed-off-by: Olof Johansson <olof@lixom.net>
Signed-off-by: Chris Mason <clm@fb.clm>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Dan Williams <dan.j.williams@intel.com>
---
Changes since v1 [1]
- Drop inclusive-terminology.rst, it is in the lore archives if the
arguments are needed for future debates, but otherwise no pressing
need to carry it in the tree (Linus, James)
- Update the recommended terms to include replacement for 'master' and
'whitelist' (Kees, Andy)
- Add 'target' as a replacement (Andy)
- Add 'device' as a replacement (Mark)
- Collect acks and signed-off-bys. Yes, the sign-offs are not reflective
of a submission chain, but I kept "Signed-off-by" if people offered
it.
- Non-change: I did not add explicit language as to what to do with
existing usages. My personal inclination is to prioritize this
coding-style cleanup higher than others, but the coding-style document
has typically not indicated policy on how cleanups are handled by
subsystems. It will be a case by case effort and consideration.
[1]: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
Documentation/process/coding-style.rst | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
index 2657a55c6f12..a5b61e9005ac 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -319,6 +319,19 @@ 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, avoid introducing new usage of 'master/slave' (or
+'slave' independent of 'master') and 'blacklist/whitelist'. Recommended
+replacements for 'master/slave' are: 'main/{secondary,subordinate}',
+'primary/replica', '{initiator,requester}/{target,responder}',
+'host/{device,proxy}', or 'leader/{performer,follower}'. Recommended
+replacements for 'blacklist/whitelist' are: 'denylist/allowlist' or
+'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 related [flat|nested] 16+ messages in thread
* Re: [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-08 7:23 [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology Dan Williams
@ 2020-07-08 7:52 ` Dan Williams
2020-07-08 8:22 ` Kees Cook
` (9 subsequent siblings)
10 siblings, 0 replies; 16+ messages in thread
From: Dan Williams @ 2020-07-08 7:52 UTC (permalink / raw)
To: Jonathan Corbet
Cc: ksummit, Greg Kroah-Hartman, SeongJae Park,
Linux Kernel Mailing List, tech-board-discuss, Dave Airlie
On Wed, Jul 8, 2020 at 12:40 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.
>
> Link: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
> Cc: Jonathan Corbet <corbet@lwn.net>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: Kees Cook <keescook@chromium.org>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Signed-off-by: Olof Johansson <olof@lixom.net>
> Signed-off-by: Chris Mason <clm@fb.clm>
Copy - paste error of Chris's address, should be .com of course.
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>
> ---
> Changes since v1 [1]
> - Drop inclusive-terminology.rst, it is in the lore archives if the
> arguments are needed for future debates, but otherwise no pressing
> need to carry it in the tree (Linus, James)
>
> - Update the recommended terms to include replacement for 'master' and
> 'whitelist' (Kees, Andy)
>
> - Add 'target' as a replacement (Andy)
>
> - Add 'device' as a replacement (Mark)
>
> - Collect acks and signed-off-bys. Yes, the sign-offs are not reflective
> of a submission chain, but I kept "Signed-off-by" if people offered
> it.
>
> - Non-change: I did not add explicit language as to what to do with
> existing usages. My personal inclination is to prioritize this
> coding-style cleanup higher than others, but the coding-style document
> has typically not indicated policy on how cleanups are handled by
> subsystems. It will be a case by case effort and consideration.
>
> [1]: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
>
> Documentation/process/coding-style.rst | 13 +++++++++++++
> 1 file changed, 13 insertions(+)
>
> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
> index 2657a55c6f12..a5b61e9005ac 100644
> --- a/Documentation/process/coding-style.rst
> +++ b/Documentation/process/coding-style.rst
> @@ -319,6 +319,19 @@ 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, avoid introducing new usage of 'master/slave' (or
> +'slave' independent of 'master') and 'blacklist/whitelist'. Recommended
> +replacements for 'master/slave' are: 'main/{secondary,subordinate}',
> +'primary/replica', '{initiator,requester}/{target,responder}',
> +'host/{device,proxy}', or 'leader/{performer,follower}'. Recommended
> +replacements for 'blacklist/whitelist' are: 'denylist/allowlist' or
> +'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] 16+ messages in thread
* Re: [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-08 7:23 [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology Dan Williams
2020-07-08 7:52 ` Dan Williams
@ 2020-07-08 8:22 ` Kees Cook
2020-07-08 14:43 ` Dan Williams
2020-07-08 9:30 ` [Ksummit-discuss] [Tech-board-discuss] " Mark Brown
` (8 subsequent siblings)
10 siblings, 1 reply; 16+ messages in thread
From: Kees Cook @ 2020-07-08 8:22 UTC (permalink / raw)
To: Dan Williams
Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
tech-board-discuss, Chris Mason, Dave Airlie
On Wed, Jul 08, 2020 at 12:23:59AM -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
> Cc: Jonathan Corbet <corbet@lwn.net>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: Kees Cook <keescook@chromium.org>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Signed-off-by: Olof Johansson <olof@lixom.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 v1 [1]
> - Drop inclusive-terminology.rst, it is in the lore archives if the
> arguments are needed for future debates, but otherwise no pressing
> need to carry it in the tree (Linus, James)
>
> - Update the recommended terms to include replacement for 'master' and
> 'whitelist' (Kees, Andy)
>
> - Add 'target' as a replacement (Andy)
>
> - Add 'device' as a replacement (Mark)
>
> - Collect acks and signed-off-bys. Yes, the sign-offs are not reflective
> of a submission chain, but I kept "Signed-off-by" if people offered
> it.
In that case, I will "upgrade" my Ack. ;)
Signed-off-by: Kees Cook <keescook@chromium.org>
:)
> - Non-change: I did not add explicit language as to what to do with
> existing usages. My personal inclination is to prioritize this
> coding-style cleanup higher than others, but the coding-style document
> has typically not indicated policy on how cleanups are handled by
> subsystems. It will be a case by case effort and consideration.
While I'd like to have published guidance on fixing existing language
(which is already underway[1]), I agree: let's start here.
> [...]
> +For symbol names, avoid introducing new usage of 'master/slave' (or
For symbol names, comments, documentation, and other language, avoid
introducing ...
> +'slave' independent of 'master') and 'blacklist/whitelist'. Recommended
> +replacements for 'master/slave' are: 'main/{secondary,subordinate}',
> +'primary/replica', '{initiator,requester}/{target,responder}',
the main and primary should be merged, IMO:
'{primary,main}/{secondary,replica,subordinate}'
> +'host/{device,proxy}', or 'leader/{performer,follower}'. Recommended
leader/performer does not track for me. Split it out?
'leader/follower', 'director/performer'
I have also seen:
'controller/worker'
Thanks!
-Kees
[1] https://lore.kernel.org/lkml/20200630174123.GA1906678@kroah.com/
https://lore.kernel.org/lkml/20200701171555.3198836-1-gregkh@linuxfoundation.org/
--
Kees Cook
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [Ksummit-discuss] [Tech-board-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-08 7:23 [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology Dan Williams
2020-07-08 7:52 ` Dan Williams
2020-07-08 8:22 ` Kees Cook
@ 2020-07-08 9:30 ` Mark Brown
2020-07-08 10:07 ` [Ksummit-discuss] " Dan Carpenter
` (7 subsequent siblings)
10 siblings, 0 replies; 16+ messages in thread
From: Mark Brown @ 2020-07-08 9:30 UTC (permalink / raw)
To: Dan Williams
Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
tech-board-discuss, Chris Mason, Dave Airlie
[-- Attachment #1.1: Type: text/plain, Size: 408 bytes --]
On Wed, Jul 08, 2020 at 12:23:59AM -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.
Reviwed-by: Mark Brown <broonie@kernel.org>
> +'host/{device,proxy}', or 'leader/{performer,follower}'. Recommended
We could have controller as well as host.
[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
[-- Attachment #2: Type: text/plain, Size: 186 bytes --]
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-08 7:23 [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology Dan Williams
` (2 preceding siblings ...)
2020-07-08 9:30 ` [Ksummit-discuss] [Tech-board-discuss] " Mark Brown
@ 2020-07-08 10:07 ` Dan Carpenter
2020-07-08 11:04 ` Joe Perches
` (6 subsequent siblings)
10 siblings, 0 replies; 16+ messages in thread
From: Dan Carpenter @ 2020-07-08 10:07 UTC (permalink / raw)
To: Dan Williams
Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
tech-board-discuss, Chris Mason, Dave Airlie
Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
regards,
dan carpenter
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-08 7:23 [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology Dan Williams
` (3 preceding siblings ...)
2020-07-08 10:07 ` [Ksummit-discuss] " Dan Carpenter
@ 2020-07-08 11:04 ` Joe Perches
2020-07-08 15:14 ` Dan Williams
2020-07-08 15:59 ` [Ksummit-discuss] [Tech-board-discuss] " James Bottomley
2020-07-08 14:22 ` [Ksummit-discuss] " tytso
` (5 subsequent siblings)
10 siblings, 2 replies; 16+ messages in thread
From: Joe Perches @ 2020-07-08 11:04 UTC (permalink / raw)
To: Dan Williams, Jonathan Corbet
Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
tech-board-discuss, Chris Mason, Dave Airlie
On Wed, 2020-07-08 at 00:23 -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
> Cc: Jonathan Corbet <corbet@lwn.net>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: Kees Cook <keescook@chromium.org>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Signed-off-by: Olof Johansson <olof@lixom.net>
> Signed-off-by: Chris Mason <clm@fb.clm>
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>
> ---
> Changes since v1 [1]
> - Drop inclusive-terminology.rst, it is in the lore archives if the
> arguments are needed for future debates, but otherwise no pressing
> need to carry it in the tree (Linus, James)
Where did Linus publicly state this was unnecessary?
> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
[]
> @@ -319,6 +319,19 @@ 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, avoid introducing new usage of 'master/slave' (or
> +'slave' independent of 'master') and 'blacklist/whitelist'. Recommended
> +replacements for 'master/slave' are: 'main/{secondary,subordinate}',
> +'primary/replica', '{initiator,requester}/{target,responder}',
> +'host/{device,proxy}', or 'leader/{performer,follower}'. Recommended
> +replacements for 'blacklist/whitelist' are: 'denylist/allowlist' or
> +'blocklist/passlist'.
Adding a reference to SeongJae Park's introduction of
scripts/deprecated_terms.txt or the like might help
make this list unnecessary if more terms are added.
> +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.
I believe any existing code should not be changed,
not just code that is required to be maintained
for userspace.
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-08 7:23 [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology Dan Williams
` (4 preceding siblings ...)
2020-07-08 11:04 ` Joe Perches
@ 2020-07-08 14:22 ` tytso
2020-07-08 16:23 ` Christian Brauner
` (4 subsequent siblings)
10 siblings, 0 replies; 16+ messages in thread
From: tytso @ 2020-07-08 14:22 UTC (permalink / raw)
To: Dan Williams
Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
tech-board-discuss, Chris Mason, Dave Airlie
On Wed, Jul 08, 2020 at 12:23:59AM -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
> Cc: Jonathan Corbet <corbet@lwn.net>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: Kees Cook <keescook@chromium.org>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Signed-off-by: Olof Johansson <olof@lixom.net>
> Signed-off-by: Chris Mason <clm@fb.clm>
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>
Signed-off-by: Theodore Ts'o <tytso@mit.edu>
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-08 8:22 ` Kees Cook
@ 2020-07-08 14:43 ` Dan Williams
0 siblings, 0 replies; 16+ messages in thread
From: Dan Williams @ 2020-07-08 14:43 UTC (permalink / raw)
To: Kees Cook
Cc: ksummit, Greg Kroah-Hartman, SeongJae Park,
Linux Kernel Mailing List, tech-board-discuss, Chris Mason,
Dave Airlie
On Wed, Jul 8, 2020 at 1:22 AM Kees Cook <keescook@chromium.org> wrote:
>
> On Wed, Jul 08, 2020 at 12:23:59AM -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
> > Cc: Jonathan Corbet <corbet@lwn.net>
> > Acked-by: Randy Dunlap <rdunlap@infradead.org>
> > Acked-by: Dave Airlie <airlied@redhat.com>
> > Acked-by: Kees Cook <keescook@chromium.org>
> > Acked-by: SeongJae Park <sjpark@amazon.de>
> > Signed-off-by: Olof Johansson <olof@lixom.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 v1 [1]
> > - Drop inclusive-terminology.rst, it is in the lore archives if the
> > arguments are needed for future debates, but otherwise no pressing
> > need to carry it in the tree (Linus, James)
> >
> > - Update the recommended terms to include replacement for 'master' and
> > 'whitelist' (Kees, Andy)
> >
> > - Add 'target' as a replacement (Andy)
> >
> > - Add 'device' as a replacement (Mark)
> >
> > - Collect acks and signed-off-bys. Yes, the sign-offs are not reflective
> > of a submission chain, but I kept "Signed-off-by" if people offered
> > it.
>
> In that case, I will "upgrade" my Ack. ;)
>
> Signed-off-by: Kees Cook <keescook@chromium.org>
>
> :)
Noted.
>
> > - Non-change: I did not add explicit language as to what to do with
> > existing usages. My personal inclination is to prioritize this
> > coding-style cleanup higher than others, but the coding-style document
> > has typically not indicated policy on how cleanups are handled by
> > subsystems. It will be a case by case effort and consideration.
>
> While I'd like to have published guidance on fixing existing language
> (which is already underway[1]), I agree: let's start here.
>
> > [...]
> > +For symbol names, avoid introducing new usage of 'master/slave' (or
>
> For symbol names, comments, documentation, and other language, avoid
> introducing ...
How about "symbol names and documentation" because I'm struggling to
think of an example of where this terminology would leak in outside
those broad categories.
> > +'slave' independent of 'master') and 'blacklist/whitelist'. Recommended
> > +replacements for 'master/slave' are: 'main/{secondary,subordinate}',
> > +'primary/replica', '{initiator,requester}/{target,responder}',
>
> the main and primary should be merged, IMO:
>
> '{primary,main}/{secondary,replica,subordinate}'
Ok.
>
> > +'host/{device,proxy}', or 'leader/{performer,follower}'. Recommended
>
> leader/performer does not track for me. Split it out?
>
> 'leader/follower', 'director/performer'
Sounds good.
> I have also seen:
>
> 'controller/worker'
Will add.
Thanks Kees.
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-08 11:04 ` Joe Perches
@ 2020-07-08 15:14 ` Dan Williams
2020-07-08 15:59 ` [Ksummit-discuss] [Tech-board-discuss] " James Bottomley
1 sibling, 0 replies; 16+ messages in thread
From: Dan Williams @ 2020-07-08 15:14 UTC (permalink / raw)
To: Joe Perches
Cc: ksummit, Greg Kroah-Hartman, SeongJae Park,
Linux Kernel Mailing List, tech-board-discuss, Chris Mason,
Dave Airlie
On Wed, Jul 8, 2020 at 4:05 AM Joe Perches <joe@perches.com> wrote:
>
> On Wed, 2020-07-08 at 00:23 -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
> > Cc: Jonathan Corbet <corbet@lwn.net>
> > Acked-by: Randy Dunlap <rdunlap@infradead.org>
> > Acked-by: Dave Airlie <airlied@redhat.com>
> > Acked-by: Kees Cook <keescook@chromium.org>
> > Acked-by: SeongJae Park <sjpark@amazon.de>
> > Signed-off-by: Olof Johansson <olof@lixom.net>
> > Signed-off-by: Chris Mason <clm@fb.clm>
> > Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> > Signed-off-by: Dan Williams <dan.j.williams@intel.com>
> > ---
> > Changes since v1 [1]
> > - Drop inclusive-terminology.rst, it is in the lore archives if the
> > arguments are needed for future debates, but otherwise no pressing
> > need to carry it in the tree (Linus, James)
>
> Where did Linus publicly state this was unnecessary?
James suggested dropping the document, Linus agreed, I agreed.
>
> > diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
> []
> > @@ -319,6 +319,19 @@ 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, avoid introducing new usage of 'master/slave' (or
> > +'slave' independent of 'master') and 'blacklist/whitelist'. Recommended
> > +replacements for 'master/slave' are: 'main/{secondary,subordinate}',
> > +'primary/replica', '{initiator,requester}/{target,responder}',
> > +'host/{device,proxy}', or 'leader/{performer,follower}'. Recommended
> > +replacements for 'blacklist/whitelist' are: 'denylist/allowlist' or
> > +'blocklist/passlist'.
>
> Adding a reference to SeongJae Park's introduction of
> scripts/deprecated_terms.txt or the like might help
> make this list unnecessary if more terms are added.
Per his last mail he's going to update his checker to refer to coding-style.
> > +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.
>
> I believe any existing code should not be changed,
> not just code that is required to be maintained
> for userspace.
We have existing practices around coding-style changes that can be
applied here. Some subsystems are open to modernizing their code with
respect to the latest coding style recommendations and others,
especially those with ancient drivers don't want the churn. So, I
would hold these cleanups to the same standard.
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [Ksummit-discuss] [Tech-board-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-08 11:04 ` Joe Perches
2020-07-08 15:14 ` Dan Williams
@ 2020-07-08 15:59 ` James Bottomley
1 sibling, 0 replies; 16+ messages in thread
From: James Bottomley @ 2020-07-08 15:59 UTC (permalink / raw)
To: Joe Perches, Dan Williams, Jonathan Corbet
Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
tech-board-discuss, Chris Mason, Dave Airlie
On Wed, 2020-07-08 at 04:04 -0700, Joe Perches wrote:
> On Wed, 2020-07-08 at 00:23 -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.135901422546687
> > 87525.stgit@dwillia2-desk3.amr.corp.intel.com
> > Cc: Jonathan Corbet <corbet@lwn.net>
> > Acked-by: Randy Dunlap <rdunlap@infradead.org>
> > Acked-by: Dave Airlie <airlied@redhat.com>
> > Acked-by: Kees Cook <keescook@chromium.org>
> > Acked-by: SeongJae Park <sjpark@amazon.de>
> > Signed-off-by: Olof Johansson <olof@lixom.net>
> > Signed-off-by: Chris Mason <clm@fb.clm>
> > Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> > Signed-off-by: Dan Williams <dan.j.williams@intel.com>
> > ---
> > Changes since v1 [1]
> > - Drop inclusive-terminology.rst, it is in the lore archives if the
> > arguments are needed for future debates, but otherwise no
> > pressing
> > need to carry it in the tree (Linus, James)
Acked-by: James Bottomley <James.Bottomley@HansenPartnership.com>
> Where did Linus publicly state this was unnecessary?
https://lists.linuxfoundation.org/pipermail/tech-board-discuss/2020-July/000412.html
James
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-08 7:23 [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology Dan Williams
` (5 preceding siblings ...)
2020-07-08 14:22 ` [Ksummit-discuss] " tytso
@ 2020-07-08 16:23 ` Christian Brauner
2020-07-08 16:42 ` [Ksummit-discuss] [Tech-board-discuss] " Shuah Khan
` (3 subsequent siblings)
10 siblings, 0 replies; 16+ messages in thread
From: Christian Brauner @ 2020-07-08 16:23 UTC (permalink / raw)
To: Dan Williams
Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
tech-board-discuss, Chris Mason, Dave Airlie
On Wed, Jul 08, 2020 at 12:23:59AM -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
> Cc: Jonathan Corbet <corbet@lwn.net>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: Kees Cook <keescook@chromium.org>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Signed-off-by: Olof Johansson <olof@lixom.net>
> Signed-off-by: Chris Mason <clm@fb.clm>
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>
> ---
Probably got lost somewhere:
Acked-by: Christian Brauner <christian.brauner@ubuntu.com>
> Changes since v1 [1]
> - Drop inclusive-terminology.rst, it is in the lore archives if the
> arguments are needed for future debates, but otherwise no pressing
> need to carry it in the tree (Linus, James)
>
> - Update the recommended terms to include replacement for 'master' and
> 'whitelist' (Kees, Andy)
>
> - Add 'target' as a replacement (Andy)
>
> - Add 'device' as a replacement (Mark)
>
> - Collect acks and signed-off-bys. Yes, the sign-offs are not reflective
> of a submission chain, but I kept "Signed-off-by" if people offered
> it.
>
> - Non-change: I did not add explicit language as to what to do with
> existing usages. My personal inclination is to prioritize this
> coding-style cleanup higher than others, but the coding-style document
> has typically not indicated policy on how cleanups are handled by
> subsystems. It will be a case by case effort and consideration.
>
> [1]: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
>
> Documentation/process/coding-style.rst | 13 +++++++++++++
> 1 file changed, 13 insertions(+)
>
> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
> index 2657a55c6f12..a5b61e9005ac 100644
> --- a/Documentation/process/coding-style.rst
> +++ b/Documentation/process/coding-style.rst
> @@ -319,6 +319,19 @@ 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, avoid introducing new usage of 'master/slave' (or
> +'slave' independent of 'master') and 'blacklist/whitelist'. Recommended
> +replacements for 'master/slave' are: 'main/{secondary,subordinate}',
> +'primary/replica', '{initiator,requester}/{target,responder}',
> +'host/{device,proxy}', or 'leader/{performer,follower}'. Recommended
> +replacements for 'blacklist/whitelist' are: 'denylist/allowlist' or
> +'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] 16+ messages in thread
* Re: [Ksummit-discuss] [Tech-board-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-08 7:23 [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology Dan Williams
` (6 preceding siblings ...)
2020-07-08 16:23 ` Christian Brauner
@ 2020-07-08 16:42 ` Shuah Khan
2020-07-08 18:59 ` [Ksummit-discuss] " Stephen Hemminger
` (2 subsequent siblings)
10 siblings, 0 replies; 16+ messages in thread
From: Shuah Khan @ 2020-07-08 16:42 UTC (permalink / raw)
To: Dan Williams, corbet
Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
tech-board-discuss, Chris Mason, Dave Airlie
On 7/8/20 1:23 AM, 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
> Cc: Jonathan Corbet <corbet@lwn.net>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: Kees Cook <keescook@chromium.org>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Signed-off-by: Olof Johansson <olof@lixom.net>
> Signed-off-by: Chris Mason <clm@fb.clm>
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>
> ---
> Changes since v1 [1]
> - Drop inclusive-terminology.rst, it is in the lore archives if the
> arguments are needed for future debates, but otherwise no pressing
> need to carry it in the tree (Linus, James)
>
> - Update the recommended terms to include replacement for 'master' and
> 'whitelist' (Kees, Andy)
>
> - Add 'target' as a replacement (Andy)
>
> - Add 'device' as a replacement (Mark)
>
> - Collect acks and signed-off-bys. Yes, the sign-offs are not reflective
> of a submission chain, but I kept "Signed-off-by" if people offered
> it.
>
Dan,
Looks like you missed my Signed-off I sent for v1
Please add my Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
thanks,
-- Shuah
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-08 7:23 [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology Dan Williams
` (7 preceding siblings ...)
2020-07-08 16:42 ` [Ksummit-discuss] [Tech-board-discuss] " Shuah Khan
@ 2020-07-08 18:59 ` Stephen Hemminger
2020-07-10 16:02 ` Linus Walleij
2020-07-11 13:30 ` Pavel Machek
10 siblings, 0 replies; 16+ messages in thread
From: Stephen Hemminger @ 2020-07-08 18:59 UTC (permalink / raw)
To: Dan Williams
Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
tech-board-discuss, Chris Mason, Dave Airlie
On Wed, 08 Jul 2020 00:23:59 -0700
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
> Cc: Jonathan Corbet <corbet@lwn.net>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: Kees Cook <keescook@chromium.org>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Signed-off-by: Olof Johansson <olof@lixom.net>
> Signed-off-by: Chris Mason <clm@fb.clm>
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>
Thanks for doing this.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-08 7:23 [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology Dan Williams
` (8 preceding siblings ...)
2020-07-08 18:59 ` [Ksummit-discuss] " Stephen Hemminger
@ 2020-07-10 16:02 ` Linus Walleij
2020-07-10 16:13 ` Dan Williams
2020-07-11 13:30 ` Pavel Machek
10 siblings, 1 reply; 16+ messages in thread
From: Linus Walleij @ 2020-07-10 16:02 UTC (permalink / raw)
To: Dan Williams
Cc: ksummit, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
tech-board-discuss, Chris Mason, Dave Airlie
On Wed, Jul 8, 2020 at 9:40 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.
>
> Link: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
> Cc: Jonathan Corbet <corbet@lwn.net>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Dave Airlie <airlied@redhat.com>
> Acked-by: Kees Cook <keescook@chromium.org>
> Acked-by: SeongJae Park <sjpark@amazon.de>
> Signed-off-by: Olof Johansson <olof@lixom.net>
> Signed-off-by: Chris Mason <clm@fb.clm>
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
An interesting piece on the topic is Douglas R. Hofstadter's
satirical "A Person paper On Purity in Language" from 1985,
which is funny, witty, Jonathan Swift-like and at one point
convinced me on the importance of proper language in
my professional work.
http://www.cs.virginia.edu/~evans/cs655/readings/purity.html
Thanks,
Linus Walleij
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-10 16:02 ` Linus Walleij
@ 2020-07-10 16:13 ` Dan Williams
0 siblings, 0 replies; 16+ messages in thread
From: Dan Williams @ 2020-07-10 16:13 UTC (permalink / raw)
To: Linus Walleij
Cc: ksummit, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
tech-board-discuss, Chris Mason, Dave Airlie
On Fri, Jul 10, 2020 at 9:03 AM Linus Walleij <linus.walleij@linaro.org> wrote:
>
> On Wed, Jul 8, 2020 at 9:40 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.
> >
> > Link: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com
> > Cc: Jonathan Corbet <corbet@lwn.net>
> > Acked-by: Randy Dunlap <rdunlap@infradead.org>
> > Acked-by: Dave Airlie <airlied@redhat.com>
> > Acked-by: Kees Cook <keescook@chromium.org>
> > Acked-by: SeongJae Park <sjpark@amazon.de>
> > Signed-off-by: Olof Johansson <olof@lixom.net>
> > Signed-off-by: Chris Mason <clm@fb.clm>
> > Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> > Signed-off-by: Dan Williams <dan.j.williams@intel.com>
>
> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
Thanks Linus.
>
> An interesting piece on the topic is Douglas R. Hofstadter's
> satirical "A Person paper On Purity in Language" from 1985,
> which is funny, witty, Jonathan Swift-like and at one point
> convinced me on the importance of proper language in
> my professional work.
> http://www.cs.virginia.edu/~evans/cs655/readings/purity.html
...and thanks for that laugh.
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology
2020-07-08 7:23 [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology Dan Williams
` (9 preceding siblings ...)
2020-07-10 16:02 ` Linus Walleij
@ 2020-07-11 13:30 ` Pavel Machek
10 siblings, 0 replies; 16+ messages in thread
From: Pavel Machek @ 2020-07-11 13:30 UTC (permalink / raw)
To: Dan Williams
Cc: ksummit-discuss, Greg Kroah-Hartman, SeongJae Park, linux-kernel,
tech-board-discuss, Chris Mason, Dave Airlie
[-- Attachment #1.1: Type: text/plain, Size: 696 bytes --]
On Wed 2020-07-08 00:23:59, 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.
>
> +replacements for 'blacklist/whitelist' are: 'denylist/allowlist' or
> +'blocklist/passlist'.
I don't see what is "non inclusive" about blacklist and whitelist...
Plus, please grep kernel for actual usages. blocklist/denylist is
_not_ suitable replacement for kernel use of blacklist.
Pavel
--
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
[-- Attachment #1.2: Digital signature --]
[-- Type: application/pgp-signature, Size: 181 bytes --]
[-- Attachment #2: Type: text/plain, Size: 186 bytes --]
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
^ permalink raw reply [flat|nested] 16+ messages in thread
end of thread, other threads:[~2020-07-11 13:31 UTC | newest]
Thread overview: 16+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-08 7:23 [Ksummit-discuss] [PATCH v2] CodingStyle: Inclusive Terminology Dan Williams
2020-07-08 7:52 ` Dan Williams
2020-07-08 8:22 ` Kees Cook
2020-07-08 14:43 ` Dan Williams
2020-07-08 9:30 ` [Ksummit-discuss] [Tech-board-discuss] " Mark Brown
2020-07-08 10:07 ` [Ksummit-discuss] " Dan Carpenter
2020-07-08 11:04 ` Joe Perches
2020-07-08 15:14 ` Dan Williams
2020-07-08 15:59 ` [Ksummit-discuss] [Tech-board-discuss] " James Bottomley
2020-07-08 14:22 ` [Ksummit-discuss] " tytso
2020-07-08 16:23 ` Christian Brauner
2020-07-08 16:42 ` [Ksummit-discuss] [Tech-board-discuss] " Shuah Khan
2020-07-08 18:59 ` [Ksummit-discuss] " Stephen Hemminger
2020-07-10 16:02 ` Linus Walleij
2020-07-10 16:13 ` Dan Williams
2020-07-11 13:30 ` Pavel Machek
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).