diff mbox series

[4/9] docs: i2c: smbus-protocol: improve DataLow/DataHigh definition

Message ID 20220808141708.1021103-5-luca.ceresoli@bootlin.com
State Accepted
Headers show
Series docs: i2c: rework I2C documentation, part II | expand

Commit Message

Luca Ceresoli Aug. 8, 2022, 2:17 p.m. UTC
From: Luca Ceresoli <luca.ceresoli@bootlin.com>

Use a more professional wording.

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
 Documentation/i2c/smbus-protocol.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Bagas Sanjaya Aug. 9, 2022, 1:55 a.m. UTC | #1
On 8/8/22 21:17, luca.ceresoli@bootlin.com wrote:
> From: Luca Ceresoli <luca.ceresoli@bootlin.com>
> 
> Use a more professional wording.
> 
> Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
> ---
>  Documentation/i2c/smbus-protocol.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/i2c/smbus-protocol.rst b/Documentation/i2c/smbus-protocol.rst
> index 55e209c7e520..4942c4cad4ad 100644
> --- a/Documentation/i2c/smbus-protocol.rst
> +++ b/Documentation/i2c/smbus-protocol.rst
> @@ -45,8 +45,8 @@ Addr  (7 bits)  I2C 7 bit address. Note that this can be expanded to
>                  get a 10 bit I2C address.
>  Comm  (8 bits)  Command byte, a data byte which often selects a register on
>                  the device.
> -Data  (8 bits)  A plain data byte. Sometimes, I write DataLow, DataHigh
> -                for 16 bit data.
> +Data  (8 bits)  A plain data byte. DataLow and DataHigh represent the low and
> +                high byte of a 16 bit word.
>  Count (8 bits)  A data byte containing the length of a block operation.
>  
>  [..]            Data sent by I2C device, as opposed to data sent by the host

Looks better, thanks.

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Wolfram Sang Aug. 11, 2022, 9:05 p.m. UTC | #2
On Mon, Aug 08, 2022 at 04:17:03PM +0200, luca.ceresoli@bootlin.com wrote:
> From: Luca Ceresoli <luca.ceresoli@bootlin.com>
> 
> Use a more professional wording.
> 
> Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>

Applied to for-current, thanks!
diff mbox series

Patch

diff --git a/Documentation/i2c/smbus-protocol.rst b/Documentation/i2c/smbus-protocol.rst
index 55e209c7e520..4942c4cad4ad 100644
--- a/Documentation/i2c/smbus-protocol.rst
+++ b/Documentation/i2c/smbus-protocol.rst
@@ -45,8 +45,8 @@  Addr  (7 bits)  I2C 7 bit address. Note that this can be expanded to
                 get a 10 bit I2C address.
 Comm  (8 bits)  Command byte, a data byte which often selects a register on
                 the device.
-Data  (8 bits)  A plain data byte. Sometimes, I write DataLow, DataHigh
-                for 16 bit data.
+Data  (8 bits)  A plain data byte. DataLow and DataHigh represent the low and
+                high byte of a 16 bit word.
 Count (8 bits)  A data byte containing the length of a block operation.
 
 [..]            Data sent by I2C device, as opposed to data sent by the host