mbox series

[0/5] docs: i2c: summary: update and use inclusive wording

Message ID 20240607111726.12678-1-wsa+renesas@sang-engineering.com
Headers show
Series docs: i2c: summary: update and use inclusive wording | expand

Message

Wolfram Sang June 7, 2024, 11:17 a.m. UTC 
The main motivation for this series is patch 4: switching to
"controller/master" when defining the I2C terminology. This sets the
base for further improvements to inclusive language within the Linux
Kernel. The other patches are improvements found on the way.

Wolfram Sang (5):
  docs: i2c: summary: start sentences consistently.
  docs: i2c: summary: update I2C specification link
  docs: i2c: summary: update speed mode description
  docs: i2c: summary: document use of inclusive language
  docs: i2c: summary: rephrase paragraph explaining the figure

 Documentation/i2c/i2c_bus.svg | 15 ++++++-----
 Documentation/i2c/summary.rst | 51 ++++++++++++++++++++---------------
 2 files changed, 38 insertions(+), 28 deletions(-)

Comments

Easwar Hariharan June 7, 2024, 6:17 p.m. UTC | #1 
On 6/7/2024 4:17 AM, Wolfram Sang wrote:
> Use 'controller/target' and 'adapter/client' pairs consistently.
> 
> Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
> ---
>  Documentation/i2c/summary.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst
> index b10b6aaafcec..1b5bc7ed46aa 100644
> --- a/Documentation/i2c/summary.rst
> +++ b/Documentation/i2c/summary.rst
> @@ -55,9 +55,9 @@ in a directory specific to the feature they provide, for example
>  ``drivers/media/gpio/`` for GPIO expanders and ``drivers/media/i2c/`` for
>  video-related chips.
>  
> -For the example configuration in figure, you will need a driver for your
> -I2C adapter, and drivers for your I2C devices (usually one driver for each
> -device).
> +For the example configuration in the figure above, you will need one adapter
> +driver for the I2C controller, and client drivers for your I2C targets. Usually
> +one driver for each client.
>  
>  Outdated terminology
>  --------------------

Similar feedback as for patch 4. I thought we agreed on using {local,
remote} target for in-line clarity.

Thanks,
Easwar