mbox series

[v4,0/6] docs: i2c: summary: update and use inclusive wording

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

Message

Wolfram Sang June 21, 2024, 7:30 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.

Changes since v3:
* reword "Synonyms" paragraph in patch 6 to be more clear


Wolfram Sang (6):
  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: document 'local' and 'remote' targets
  docs: i2c: summary: be clearer with 'controller/target' and
    'adapter/client' pairs

 Documentation/i2c/i2c_bus.svg | 15 +++----
 Documentation/i2c/summary.rst | 79 ++++++++++++++++++++++-------------
 2 files changed, 58 insertions(+), 36 deletions(-)

Comments

Easwar Hariharan June 21, 2024, 4:09 p.m. UTC | #1
On 6/21/2024 12:30 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(-)
>

Looks good to me.

Reviewed-by: Easwar Hariharan <eahariha@linux.microsoft.com>
Easwar Hariharan June 21, 2024, 4:11 p.m. UTC | #2
On 6/21/2024 12:30 AM, Wolfram Sang wrote:
> This not only includes rewording, but also where to put which emphasis
> on terms in this document.
> 
> Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
> ---
>  Documentation/i2c/summary.rst | 41 ++++++++++++++++++++---------------
>  1 file changed, 24 insertions(+), 17 deletions(-)
> 
> diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst
> index ff8bda32b9c3..579a1c7df200 100644
> --- a/Documentation/i2c/summary.rst
> +++ b/Documentation/i2c/summary.rst
> @@ -31,9 +31,7 @@ implement all the common SMBus protocol semantics or messages.

Looks good to me. Thanks for the patience and the update!

Reviewed-by: Easwar Hariharan <eahariha@linux.microsoft.com>
Wolfram Sang June 22, 2024, 8:14 a.m. UTC | #3
On Fri, Jun 21, 2024 at 09:30:07AM GMT, Wolfram Sang wrote:
> 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.
> 
> Changes since v3:
> * reword "Synonyms" paragraph in patch 6 to be more clear
> 
> 
> Wolfram Sang (6):
>   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: document 'local' and 'remote' targets
>   docs: i2c: summary: be clearer with 'controller/target' and
>     'adapter/client' pairs
> 

Applied to for-current, thanks!