docs: i2c: rename sections so the overall picture is clearer
authorLuca Ceresoli <luca@lucaceresoli.net>
Wed, 29 Jan 2020 15:19:51 +0000 (16:19 +0100)
committerWolfram Sang <wsa@the-dreams.de>
Wed, 29 Jan 2020 21:02:06 +0000 (22:02 +0100)
Some of the section names are not very clear. Reading those names in the
index.rst page does not help much in grasping what the content is supposed
to be.

Rename those sections to clarify their content, especially when reading
the index page.

Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Acked-by: Peter Rosin <peda@axentia.se>
Reviewed-by: Jean Delvare <jdelvare@suse.de>
Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
Documentation/i2c/dev-interface.rst
Documentation/i2c/i2c-protocol.rst
Documentation/i2c/i2c-topology.rst
Documentation/i2c/old-module-parameters.rst
Documentation/i2c/smbus-protocol.rst
Documentation/i2c/summary.rst
Documentation/i2c/writing-clients.rst

index c3717a87df127f29a77d487ef90e8c73869daa06..bdb247f2f11a1da35df04811610d51afddc86c19 100644 (file)
@@ -1,6 +1,6 @@
-====================
-I2C Device Interface
-====================
+============================================
+Implementing I2C device drivers in userspace
+============================================
 
 Usually, I2C devices are controlled by a kernel driver. But it is also
 possible to access all devices on an adapter from userspace, through
index 9a4ac944cf9d920fd3e1a93b65e5a560914e24a6..6aafc3880bce9264100bf5a59f465479bbcebeaf 100644 (file)
@@ -1,6 +1,6 @@
-============
-I2C Protocol
-============
+================
+The I2C Protocol
+================
 
 This document describes the I2C protocol. Or will, when it is finished :-)
 
index 2a18b53e3508c4e0f9e9daa375a5c2691553ecae..7cb53819778e6cb7d62787a62f4c124e28872d33 100644 (file)
@@ -1,6 +1,6 @@
-============
-I2C topology
-============
+================================
+I2C muxes and complex topologies
+================================
 
 There are a couple of reasons for building more complex I2C topologies
 than a straight-forward I2C bus with one adapter and one or more devices.
index 3b93cb88eebcb9e915009aef035a5e68cdfd748d..38e55829dee8247ffce4d2b64c74a6416202fe1b 100644 (file)
@@ -1,6 +1,6 @@
-=================================================
-I2C device driver binding control from user-space
-=================================================
+================================================================
+I2C device driver binding control from user-space in old kernels
+================================================================
 
 .. NOTE::
    Note: this section is only relevant if you are handling some old code
index 0edaf6069ac129a613dcd6a1be3f5ff1ac2753dc..c122ed239f7f6bbc0b1cf01e1c954b60d3018a44 100644 (file)
@@ -1,6 +1,6 @@
-======================
-SMBus Protocol Summary
-======================
+==================
+The SMBus Protocol
+==================
 
 The following is a summary of the SMBus protocol. It applies to
 all revisions of the protocol (1.0, 1.1, and 2.0).
index 09f73a608e2526bcdb5d24103304c8ca1f73c75e..ce7230025b33d27392e08619157483cf08254bda 100644 (file)
@@ -1,6 +1,6 @@
-=============
-I2C and SMBus
-=============
+=============================
+Introduction to I2C and SMBus
+=============================
 
 I²C (pronounce: I squared C and written I2C in the kernel documentation) is
 a protocol developed by Philips. It is a slow two-wire protocol (variable
index 44d97b2c9a829be2a195b730b5b90605b7ecbe83..82aa33c964d33c4129dd13bf35817009ff3f99f9 100644 (file)
@@ -1,6 +1,6 @@
-===================
-Writing I2C Clients
-===================
+===============================
+Implementing I2C device drivers
+===============================
 
 This is a small guide for those who want to write kernel drivers for I2C
 or SMBus devices, using Linux as the protocol host/master (not slave).