diff mbox series

[5/5] docs: i2c: summary: rephrase paragraph explaining the figure

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

Commit Message

Wolfram Sang June 7, 2024, 11:17 a.m. UTC
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(-)

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
diff mbox series

Patch

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
 --------------------