diff options
author | Linus Torvalds <torvalds@linux-foundation.org> | 2020-07-10 21:15:25 -0700 |
---|---|---|
committer | Linus Torvalds <torvalds@linux-foundation.org> | 2020-07-10 21:15:25 -0700 |
commit | 49decddd39e5f6132ccd7d9fdc3d7c470b0061bb (patch) | |
tree | c1bed64f71f65ca4ddc234fefc668e00c675ca03 /Documentation | |
parent | 5a764898afec0bc097003e8c3e727792289f76d6 (diff) | |
parent | a5f526ecb075a08c4a082355020166c7fe13ae27 (diff) | |
download | linux-49decddd39e5f6132ccd7d9fdc3d7c470b0061bb.tar.gz linux-49decddd39e5f6132ccd7d9fdc3d7c470b0061bb.tar.bz2 linux-49decddd39e5f6132ccd7d9fdc3d7c470b0061bb.zip |
Merge tag 'inclusive-terminology' of git://git.kernel.org/pub/scm/linux/kernel/git/djbw/linux
Pull coding style terminology documentation from Dan Williams:
"The discussion has tapered off as well as the incoming ack, review,
and sign-off tags. I did not see a reason to wait for the next merge
window"
* tag 'inclusive-terminology' of git://git.kernel.org/pub/scm/linux/kernel/git/djbw/linux:
CodingStyle: Inclusive Terminology
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/process/coding-style.rst | 20 |
1 files changed, 20 insertions, 0 deletions
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 ----------- |