From: Luca Ceresoli <luca@lucaceresoli.net>
To: linux-i2c@vger.kernel.org, linux-doc@vger.kernel.org
Cc: Luca Ceresoli <luca@lucaceresoli.net>,
Wolfram Sang <wsa@the-dreams.de>, Jean Delvare <jdelvare@suse.de>,
Peter Rosin <peda@axentia.se>,
linux-kernel@vger.kernel.org
Subject: [PATCH v2 06/28] docs: i2c: replace "I2C-transfer" -> "I2C transfer" consistently
Date: Thu, 23 Jan 2020 14:50:41 +0100 [thread overview]
Message-ID: <20200123135103.20540-7-luca@lucaceresoli.net> (raw)
In-Reply-To: <20200123135103.20540-1-luca@lucaceresoli.net>
"I2C transfer" is a legitimate english sentence, no need for a hyphen
between the two words, as as such it is used in most of the
documentation. Remove the hyphen in the few places where it is present.
Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Acked-by: Peter Rosin <peda@axentia.se>
Reviewed-by: Jean Delvare <jdelvare@suse.de>
---
Documentation/i2c/i2c-topology.rst | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/Documentation/i2c/i2c-topology.rst b/Documentation/i2c/i2c-topology.rst
index b413ef6a6773..2a18b53e3508 100644
--- a/Documentation/i2c/i2c-topology.rst
+++ b/Documentation/i2c/i2c-topology.rst
@@ -137,14 +137,14 @@ Mux-locked Example
When there is an access to D1, this happens:
- 1. Someone issues an I2C-transfer to D1.
+ 1. Someone issues an I2C transfer to D1.
2. M1 locks muxes on its parent (the root adapter in this case).
3. M1 calls ->select to ready the mux.
- 4. M1 (presumably) does some I2C-transfers as part of its select.
- These transfers are normal I2C-transfers that locks the parent
+ 4. M1 (presumably) does some I2C transfers as part of its select.
+ These transfers are normal I2C transfers that locks the parent
adapter.
- 5. M1 feeds the I2C-transfer from step 1 to its parent adapter as a
- normal I2C-transfer that locks the parent adapter.
+ 5. M1 feeds the I2C transfer from step 1 to its parent adapter as a
+ normal I2C transfer that locks the parent adapter.
6. M1 calls ->deselect, if it has one.
7. Same rules as in step 4, but for ->deselect.
8. M1 unlocks muxes on its parent.
@@ -169,7 +169,7 @@ PL1. If you build a topology with a parent-locked mux being the child
of another mux, this might break a possible assumption from the
child mux that the root adapter is unused between its select op
and the actual transfer (e.g. if the child mux is auto-closing
- and the parent mux issues I2C-transfers as part of its select).
+ and the parent mux issues I2C transfers as part of its select).
This is especially the case if the parent mux is mux-locked, but
it may also happen if the parent mux is parent-locked.
@@ -197,15 +197,15 @@ Parent-locked Example
When there is an access to D1, this happens:
- 1. Someone issues an I2C-transfer to D1.
+ 1. Someone issues an I2C transfer to D1.
2. M1 locks muxes on its parent (the root adapter in this case).
3. M1 locks its parent adapter.
4. M1 calls ->select to ready the mux.
- 5. If M1 does any I2C-transfers (on this root adapter) as part of
- its select, those transfers must be unlocked I2C-transfers so
+ 5. If M1 does any I2C transfers (on this root adapter) as part of
+ its select, those transfers must be unlocked I2C transfers so
that they do not deadlock the root adapter.
- 6. M1 feeds the I2C-transfer from step 1 to the root adapter as an
- unlocked I2C-transfer, so that it does not deadlock the parent
+ 6. M1 feeds the I2C transfer from step 1 to the root adapter as an
+ unlocked I2C transfer, so that it does not deadlock the parent
adapter.
7. M1 calls ->deselect, if it has one.
8. Same rules as in step 5, but for ->deselect.
@@ -293,7 +293,7 @@ device lockups and/or other problems.
The topology is especially troublesome if M2 is an auto-closing
mux. In that case, any interleaved accesses to D4 might close M2
-prematurely, as might any I2C-transfers part of M1->select.
+prematurely, as might any I2C transfers part of M1->select.
But if M2 is not making the above stated assumption, and if M2 is not
auto-closing, the topology is fine.
--
2.25.0
next prev parent reply other threads:[~2020-01-23 13:53 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-23 13:50 [PATCH v2 00/28] docs: i2c: rework I2C documentation, part I Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 01/28] docs: i2c: sort index logically Luca Ceresoli
2020-01-24 12:35 ` Jean Delvare
2020-01-29 12:22 ` Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 02/28] docs: i2c: summary: extend introduction Luca Ceresoli
2020-01-24 13:24 ` Jean Delvare
2020-01-23 13:50 ` [PATCH v2 03/28] docs: i2c: summary: rewrite the "terminology" section Luca Ceresoli
2020-01-24 13:28 ` Jean Delvare
2020-01-23 13:50 ` [PATCH v2 04/28] docs: i2c: call it "I2C" consistently Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 05/28] docs: i2c: fix typo Luca Ceresoli
2020-01-23 13:50 ` Luca Ceresoli [this message]
2020-01-23 13:50 ` [PATCH v2 07/28] docs: i2c: i2c-protocol: fix kernel-doc function syntax Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 08/28] docs: i2c: i2c-protocol: properly name start and stop conditions Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 09/28] docs: i2c: i2c-protocol: remove unneeded colons from table Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 10/28] docs: i2c: i2c-protocol: use proper names for ACK and NACK Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 11/28] docs: i2c: smbus: fix link syntax Luca Ceresoli
2020-01-24 14:57 ` Jean Delvare
2020-01-23 13:50 ` [PATCH v2 12/28] docs: i2c: smbus-protocol: properly name start and stop conditions Luca Ceresoli
2020-01-23 13:50 ` [PATCH v2 13/28] docs: i2c: smbus-protocol: remove unneeded colons from table Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 14/28] docs: i2c: smbus-protocol: use proper names for ACK and NACK Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 15/28] docs: i2c: smbus-protocol: enable kernel-doc function syntax Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 16/28] docs: i2c: smbus-protocol: fix " Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 17/28] docs: i2c: smbus-protocol: fix typo Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 18/28] docs: i2c: smbus-protocol: fix punctuation Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 19/28] docs: i2c: smbus-protocol: improve I2C Block transactions description Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 20/28] docs: i2c: instantiating-devices: fix internal hyperlink Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 21/28] docs: i2c: instantiating-devices: rearrange static instatiation Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 22/28] docs: i2c: instantiating-devices: use monospace for sysfs attributes Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 23/28] docs: i2c: old-module-parameters: fix internal hyperlink Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 24/28] docs: i2c: old-module-parameters: clarify this is for obsolete kernels Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 25/28] docs: i2c: old-module-parameters: use monospace instead of "" Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 26/28] docs: i2c: rename sections so the overall picture is clearer Luca Ceresoli
2020-01-23 14:56 ` [PATCH v2 27/28] docs: i2c: i2c-protocol: use same wording as smbus-protocol Luca Ceresoli
2020-01-24 15:59 ` Jean Delvare
2020-01-23 14:56 ` [PATCH v2 28/28] docs: i2c: writing-clients: properly name the stop condition Luca Ceresoli
2020-01-24 16:01 ` Jean Delvare
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=20200123135103.20540-7-luca@lucaceresoli.net \
--to=luca@lucaceresoli.net \
--cc=jdelvare@suse.de \
--cc=linux-doc@vger.kernel.org \
--cc=linux-i2c@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=peda@axentia.se \
--cc=wsa@the-dreams.de \
/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).