diff options
| author | Luca Ceresoli <luca@lucaceresoli.net> | 2020-01-29 16:19:51 +0100 |
|---|---|---|
| committer | Wolfram Sang <wsa@the-dreams.de> | 2020-01-29 22:02:06 +0100 |
| commit | f6fcefa10fdbc852ececadb1fd600570228b49ab (patch) | |
| tree | a0649e30be1b53fe504dd8f56ed393a657d400fe | |
| parent | docs: i2c: old-module-parameters: use monospace instead of "" (diff) | |
| download | linux-f6fcefa10fdbc852ececadb1fd600570228b49ab.tar.xz linux-f6fcefa10fdbc852ececadb1fd600570228b49ab.zip | |
docs: i2c: rename sections so the overall picture is clearer
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>
| -rw-r--r-- | Documentation/i2c/dev-interface.rst | 6 | ||||
| -rw-r--r-- | Documentation/i2c/i2c-protocol.rst | 6 | ||||
| -rw-r--r-- | Documentation/i2c/i2c-topology.rst | 6 | ||||
| -rw-r--r-- | Documentation/i2c/old-module-parameters.rst | 6 | ||||
| -rw-r--r-- | Documentation/i2c/smbus-protocol.rst | 6 | ||||
| -rw-r--r-- | Documentation/i2c/summary.rst | 6 | ||||
| -rw-r--r-- | Documentation/i2c/writing-clients.rst | 6 |
7 files changed, 21 insertions, 21 deletions
diff --git a/Documentation/i2c/dev-interface.rst b/Documentation/i2c/dev-interface.rst index c3717a87df12..bdb247f2f11a 100644 --- a/Documentation/i2c/dev-interface.rst +++ b/Documentation/i2c/dev-interface.rst @@ -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 diff --git a/Documentation/i2c/i2c-protocol.rst b/Documentation/i2c/i2c-protocol.rst index 9a4ac944cf9d..6aafc3880bce 100644 --- a/Documentation/i2c/i2c-protocol.rst +++ b/Documentation/i2c/i2c-protocol.rst @@ -1,6 +1,6 @@ -============ -I2C Protocol -============ +================ +The I2C Protocol +================ This document describes the I2C protocol. Or will, when it is finished :-) diff --git a/Documentation/i2c/i2c-topology.rst b/Documentation/i2c/i2c-topology.rst index 2a18b53e3508..7cb53819778e 100644 --- a/Documentation/i2c/i2c-topology.rst +++ b/Documentation/i2c/i2c-topology.rst @@ -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. diff --git a/Documentation/i2c/old-module-parameters.rst b/Documentation/i2c/old-module-parameters.rst index 3b93cb88eebc..38e55829dee8 100644 --- a/Documentation/i2c/old-module-parameters.rst +++ b/Documentation/i2c/old-module-parameters.rst @@ -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 diff --git a/Documentation/i2c/smbus-protocol.rst b/Documentation/i2c/smbus-protocol.rst index 0edaf6069ac1..c122ed239f7f 100644 --- a/Documentation/i2c/smbus-protocol.rst +++ b/Documentation/i2c/smbus-protocol.rst @@ -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). diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst index 09f73a608e25..ce7230025b33 100644 --- a/Documentation/i2c/summary.rst +++ b/Documentation/i2c/summary.rst @@ -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 diff --git a/Documentation/i2c/writing-clients.rst b/Documentation/i2c/writing-clients.rst index 44d97b2c9a82..82aa33c964d3 100644 --- a/Documentation/i2c/writing-clients.rst +++ b/Documentation/i2c/writing-clients.rst @@ -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). |