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 09/28] docs: i2c: i2c-protocol: remove unneeded colons from table
Date: Thu, 23 Jan 2020 14:50:44 +0100 [thread overview]
Message-ID: <20200123135103.20540-10-luca@lucaceresoli.net> (raw)
In-Reply-To: <20200123135103.20540-1-luca@lucaceresoli.net>
These colons are not needed: the columns already nicely separate the
symbols 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>
Reviewed-by: Jean Delvare <jdelvare@suse.de>
---
Changes in v2:
- fix typo in commit message (Jean Delvare)
---
Documentation/i2c/i2c-protocol.rst | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
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.
=============== =============================================================
--
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 ` [PATCH v2 06/28] docs: i2c: replace "I2C-transfer" -> "I2C transfer" consistently Luca Ceresoli
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 ` Luca Ceresoli [this message]
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-10-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).