docs: i2c: i2c-protocol: update introductory paragraph
authorLuca Ceresoli <luca.ceresoli@bootlin.com>
Mon, 8 Aug 2022 14:17:00 +0000 (16:17 +0200)
committerWolfram Sang <wsa@kernel.org>
Thu, 11 Aug 2022 21:02:52 +0000 (23:02 +0200)
This sentence dates back to the pre-git era and it does not look very
professional... 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>
Signed-off-by: Wolfram Sang <wsa@kernel.org>
Documentation/i2c/i2c-protocol.rst

index b2092f8..9ecf03f 100644 (file)
@@ -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
 ==============