| Message ID | 20200123145626.8102-14-luca@lucaceresoli.net |
|---|---|
| State | Superseded |
| Headers | show |
| Series | docs: i2c: rework I2C documentation, part I | expand |
On Thu, 23 Jan 2020 15:56:25 +0100, Luca Ceresoli wrote: > In smbus-protocol.rst we use the text "Implemented by" for the same meaning > as "This corresponds to". Change everything to "Implemented by" for > coherency. > > Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> > Reported-by: Jean Delvare <jdelvare@suse.de> > > --- > > This patch is new in v2. > --- > Documentation/i2c/i2c-protocol.rst | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) > > diff --git a/Documentation/i2c/i2c-protocol.rst b/Documentation/i2c/i2c-protocol.rst > index 6aafc3880bce..b2092f8f815d 100644 > --- a/Documentation/i2c/i2c-protocol.rst > +++ b/Documentation/i2c/i2c-protocol.rst > @@ -28,7 +28,7 @@ Count (8 bits) A data byte containing the length of a block operation. > Simple send transaction > ======================= > > -This corresponds to i2c_master_send():: > +Implemented by i2c_master_send():: > > S Addr Wr [A] Data [A] Data [A] ... [A] Data [A] P > > @@ -36,7 +36,7 @@ This corresponds to i2c_master_send():: > Simple receive transaction > ========================== > > -This corresponds to i2c_master_recv():: > +Implemented by i2c_master_recv():: > > S Addr Rd [A] [Data] A [Data] A ... A [Data] NA P > > @@ -44,7 +44,7 @@ This corresponds to i2c_master_recv():: > Combined transactions > ===================== > > -This corresponds to i2c_transfer(). > +Implemented by i2c_transfer(). > > They are just like the above transactions, but instead of a stop > condition P a start condition S is sent and the transaction continues. Reviewed-by: Jean Delvare <jdelvare@suse.de>
diff --git a/Documentation/i2c/i2c-protocol.rst b/Documentation/i2c/i2c-protocol.rst index 6aafc3880bce..b2092f8f815d 100644 --- a/Documentation/i2c/i2c-protocol.rst +++ b/Documentation/i2c/i2c-protocol.rst @@ -28,7 +28,7 @@ Count (8 bits) A data byte containing the length of a block operation. Simple send transaction ======================= -This corresponds to i2c_master_send():: +Implemented by i2c_master_send():: S Addr Wr [A] Data [A] Data [A] ... [A] Data [A] P @@ -36,7 +36,7 @@ This corresponds to i2c_master_send():: Simple receive transaction ========================== -This corresponds to i2c_master_recv():: +Implemented by i2c_master_recv():: S Addr Rd [A] [Data] A [Data] A ... A [Data] NA P @@ -44,7 +44,7 @@ This corresponds to i2c_master_recv():: Combined transactions ===================== -This corresponds to i2c_transfer(). +Implemented by i2c_transfer(). They are just like the above transactions, but instead of a stop condition P a start condition S is sent and the transaction continues.
In smbus-protocol.rst we use the text "Implemented by" for the same meaning as "This corresponds to". Change everything to "Implemented by" for coherency. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Reported-by: Jean Delvare <jdelvare@suse.de> --- This patch is new in v2. --- Documentation/i2c/i2c-protocol.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)