From: Easwar Hariharan <eahariha@linux.microsoft.com>
To: Wolfram Sang <wsa+renesas@sang-engineering.com>,
linux-i2c@vger.kernel.org
Cc: eahariha@linux.microsoft.com, Andi Shyti <andi.shyti@kernel.org>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 4/6] docs: i2c: summary: document use of inclusive language
Date: Mon, 10 Jun 2024 10:25:20 -0700 [thread overview]
Message-ID: <8e051ecf-a355-4aef-bc40-007f9b709ba6@linux.microsoft.com> (raw)
In-Reply-To: <20240610081023.8118-5-wsa+renesas@sang-engineering.com>
On 6/10/2024 1:10 AM, Wolfram Sang wrote:
> We now have the updated I2C specs and our own Code of Conduct, so we
> have all we need to switch over to the inclusive terminology. Define
> them here.
>
> Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
> ---
> Documentation/i2c/i2c_bus.svg | 15 ++++++++-------
> Documentation/i2c/summary.rst | 23 +++++++++++++++++------
> 2 files changed, 25 insertions(+), 13 deletions(-)
>
<snip>
> diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst
> index a1e5c0715f8b..b10b6aaafcec 100644
> --- a/Documentation/i2c/summary.rst
> +++ b/Documentation/i2c/summary.rst
> @@ -31,15 +31,16 @@ implement all the common SMBus protocol semantics or messages.
> Terminology
> ===========
>
> -Using the terminology from the official documentation, the I2C bus connects
> -one or more *master* chips and one or more *slave* chips.
> +The I2C bus connects one or more *controller* chips and one or more *target*
> +chips.
> +
>
> .. kernel-figure:: i2c_bus.svg
> - :alt: Simple I2C bus with one master and 3 slaves
> + :alt: Simple I2C bus with one controller and 3 targets
>
> Simple I2C bus
>
> -A **master** chip is a node that starts communications with slaves. In the
> +A **controller** chip is a node that starts communications with targets. In the
> Linux kernel implementation it is called an **adapter** or bus. Adapter
> drivers are in the ``drivers/i2c/busses/`` subdirectory.
>
> @@ -48,8 +49,8 @@ whole class of I2C adapters. Each specific adapter driver either depends on
> an algorithm driver in the ``drivers/i2c/algos/`` subdirectory, or includes
> its own implementation.
>
> -A **slave** chip is a node that responds to communications when addressed
> -by the master. In Linux it is called a **client**. Client drivers are kept
> +A **target** chip is a node that responds to communications when addressed
> +by the controller. In Linux it is called a **client**. Client drivers are kept
<snip>
> +
> +Outdated terminology
> +--------------------
> +
> +Historically, controller was named "master" and client was named "slave". These
> +terms have been obsoleted with v7 of the specification and their use is also
> +discouraged by the Linux Kernel Code of Conduct. You may still find them in
> +references to documentation which has not been updated. The general attitude,
> +however, is to use the inclusive terms: controller and target. Work to switch
> +over the Linux Kernel is on-going.
What's the combined effect of this documentation update in terms of the
recommendation for switching over the Linux kernel? Are we to use
controller/client or controller/target?
Confused,
Easwar
next prev parent reply other threads:[~2024-06-10 17:25 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-06-10 8:10 [PATCH v2 0/6] docs: i2c: summary: update and use inclusive wording Wolfram Sang
2024-06-10 8:10 ` [PATCH v2 1/6] docs: i2c: summary: start sentences consistently Wolfram Sang
2024-06-10 8:10 ` [PATCH v2 2/6] docs: i2c: summary: update I2C specification link Wolfram Sang
2024-06-10 8:10 ` [PATCH v2 3/6] docs: i2c: summary: update speed mode description Wolfram Sang
2024-06-10 8:10 ` [PATCH v2 4/6] docs: i2c: summary: document use of inclusive language Wolfram Sang
2024-06-10 17:25 ` Easwar Hariharan [this message]
2024-06-10 20:29 ` Wolfram Sang
2024-06-10 21:43 ` Easwar Hariharan
2024-06-12 16:14 ` Wolfram Sang
2024-06-13 19:52 ` Wolfram Sang
2024-06-13 19:57 ` Easwar Hariharan
2024-06-10 8:10 ` [PATCH v2 5/6] docs: i2c: summary: document 'local' and 'remote' targets Wolfram Sang
2024-06-13 19:55 ` Wolfram Sang
2024-06-10 8:10 ` [PATCH v2 6/6] docs: i2c: summary: rephrase paragraph explaining the figure Wolfram Sang
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8e051ecf-a355-4aef-bc40-007f9b709ba6@linux.microsoft.com \
--to=eahariha@linux.microsoft.com \
--cc=andi.shyti@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-i2c@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=wsa+renesas@sang-engineering.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).