| Message ID | 20200105225012.11701-9-luca@lucaceresoli.net |
|---|---|
| State | Changes Requested |
| Headers | show |
| Series | docs: i2c: rework I2C documentation, part I | expand |
On Sun, 5 Jan 2020 23:49:55 +0100, Luca Ceresoli wrote: > These colons are not needed: the columns already nicely separate the > symbold from their description. They are also inconsistently preceded by > whitespace. > > Remove the colons completely to simplify and clean up. > > Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> > --- > Documentation/i2c/i2c-protocol.rst | 18 +++++++++--------- > 1 file changed, 9 insertions(+), 9 deletions(-) > (...) Reviewed-by: Jean Delvare <jdelvare@suse.de>
Ah, actually... On Mon, 20 Jan 2020 14:38:52 +0100, Jean Delvare wrote: > On Sun, 5 Jan 2020 23:49:55 +0100, Luca Ceresoli wrote: > > These colons are not needed: the columns already nicely separate the > > symbold from their description. They are also inconsistently preceded by ... you have a typo there, s/symbold/symbols/. > > whitespace. > > > > Remove the colons completely to simplify and clean up. > > > > Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> > > --- > > Documentation/i2c/i2c-protocol.rst | 18 +++++++++--------- > > 1 file changed, 9 insertions(+), 9 deletions(-) > > (...) > > Reviewed-by: Jean Delvare <jdelvare@suse.de>
diff --git a/Documentation/i2c/i2c-protocol.rst b/Documentation/i2c/i2c-protocol.rst index c090003f55ed..66adac3a5afd 100644 --- a/Documentation/i2c/i2c-protocol.rst +++ b/Documentation/i2c/i2c-protocol.rst @@ -8,19 +8,19 @@ Key to symbols ============== =============== ============================================================= -S : Start condition -P : Stop condition -Rd/Wr (1 bit) : Read/Write bit. Rd equals 1, Wr equals 0. -A, NA (1 bit) : Accept and reverse accept bit. -Addr (7 bits): I2C 7 bit address. Note that this can be expanded as usual to +S Start condition +P Stop condition +Rd/Wr (1 bit) Read/Write bit. Rd equals 1, Wr equals 0. +A, NA (1 bit) Accept and reverse accept bit. +Addr (7 bits) I2C 7 bit address. Note that this can be expanded as usual to get a 10 bit I2C address. -Comm (8 bits): Command byte, a data byte which often selects a register on +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 +Data (8 bits) A plain data byte. Sometimes, I write DataLow, DataHigh for 16 bit data. -Count (8 bits): A data byte containing the length of a block operation. +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 +[..] Data sent by I2C device, as opposed to data sent by the host adapter. =============== =============================================================
These colons are not needed: the columns already nicely separate the symbold from their description. They are also inconsistently preceded by whitespace. Remove the colons completely to simplify and clean up. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> --- Documentation/i2c/i2c-protocol.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-)