Re: [PATCH 4/5] docs: i2c: summary: document use of inclusive language
From: Easwar Hariharan
Date: Fri Jun 07 2024 - 14:13:59 EST
On 6/7/2024 4:17 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@xxxxxxxxxxxxxxxxxxxx>
> ---
> 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
Are we continuing to use client instead of local target and remote target?
Thanks,
Easwar