From: luca.ceresoli@bootlin.com
To: linux-doc@vger.kernel.org, linux-i2c@vger.kernel.org
Cc: Luca Ceresoli <luca.ceresoli@bootlin.com>,
Wolfram Sang <wsa@kernel.org>, Peter Rosin <peda@axentia.se>,
linux-kernel@vger.kernel.org
Subject: [PATCH 1/9] docs: i2c: i2c-protocol: update introductory paragraph
Date: Mon, 8 Aug 2022 16:17:00 +0200 [thread overview]
Message-ID: <20220808141708.1021103-2-luca.ceresoli@bootlin.com> (raw)
In-Reply-To: <20220808141708.1021103-1-luca.ceresoli@bootlin.com>
From: Luca Ceresoli <luca.ceresoli@bootlin.com>
This sentence dates back to the pre-git era and it does not look very
prefessional... As there is no clear definition of "finished", and given
this page is already a pretty good overview, not to mention it is not the
kernel responsibility to document the protocol in detail, let's update the
text accordingly.
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
Documentation/i2c/i2c-protocol.rst | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/i2c/i2c-protocol.rst b/Documentation/i2c/i2c-protocol.rst
index b2092f8f815d..9ecf03f5de33 100644
--- a/Documentation/i2c/i2c-protocol.rst
+++ b/Documentation/i2c/i2c-protocol.rst
@@ -2,7 +2,8 @@
The I2C Protocol
================
-This document describes the I2C protocol. Or will, when it is finished :-)
+This document is an overview of the basic I2C transactions and the kernel
+APIs to perform them.
Key to symbols
==============
--
2.34.1
next prev parent reply other threads:[~2022-08-08 14:17 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-08 14:16 [PATCH 0/9] docs: i2c: rework I2C documentation, part II luca.ceresoli
2022-08-08 14:17 ` luca.ceresoli [this message]
2022-08-11 21:03 ` [PATCH 1/9] docs: i2c: i2c-protocol: update introductory paragraph Wolfram Sang
2022-08-08 14:17 ` [PATCH 2/9] docs: i2c: i2c-protocol,smbus-protocol: remove nonsense words luca.ceresoli
2022-08-11 21:03 ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 3/9] docs: i2c: i2c-protocol: remove unused legend items luca.ceresoli
2022-08-11 21:05 ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 4/9] docs: i2c: smbus-protocol: improve DataLow/DataHigh definition luca.ceresoli
2022-08-09 1:55 ` Bagas Sanjaya
2022-08-11 21:05 ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 5/9] docs: i2c: instantiating-devices: add syntax coloring to dts and C blocks luca.ceresoli
2022-08-11 21:07 ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 6/9] docs: i2c: i2c-topology: fix incorrect heading luca.ceresoli
2022-08-11 21:09 ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 7/9] docs: i2c: i2c-topology: reorder sections more logically luca.ceresoli
2022-08-09 2:08 ` Bagas Sanjaya
2022-08-09 7:06 ` Luca Ceresoli
2022-08-11 21:09 ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 8/9] docs: i2c: i2c-sysfs: improve wording luca.ceresoli
2022-08-11 21:13 ` Wolfram Sang
2022-08-11 21:23 ` Wolfram Sang
2022-08-12 7:13 ` Luca Ceresoli
2022-08-08 14:17 ` [PATCH 9/9] docs: i2c: i2c-sysfs: fix hyperlinks luca.ceresoli
2022-08-11 21:21 ` Wolfram Sang
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=20220808141708.1021103-2-luca.ceresoli@bootlin.com \
--to=luca.ceresoli@bootlin.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-i2c@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=peda@axentia.se \
--cc=wsa@kernel.org \
/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