docs: i2c: rename sections so the overall picture is clearer

Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git

kernel os linux

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>

authored by

Luca Ceresoli and committed by

Wolfram Sang 6 years ago f6fcefa1 1ef05722

+21 -21

7 changed files

expand all

Documentation

i2c

dev-interface.rst

i2c-protocol.rst

i2c-topology.rst

old-module-parameters.rst

smbus-protocol.rst

summary.rst

writing-clients.rst

+3 -3

Documentation/i2c/dev-interface.rst

··· 1 - ==================== 2 - I2C Device Interface 3 - ==================== 1 + ============================================ 2 + Implementing I2C device drivers in userspace 3 + ============================================ 4 4 5 5 Usually, I2C devices are controlled by a kernel driver. But it is also 6 6 possible to access all devices on an adapter from userspace, through

+3 -3

Documentation/i2c/i2c-protocol.rst

··· 1 - ============ 2 - I2C Protocol 3 - ============ 1 + ================ 2 + The I2C Protocol 3 + ================ 4 4 5 5 This document describes the I2C protocol. Or will, when it is finished :-) 6 6

+3 -3

Documentation/i2c/i2c-topology.rst

··· 1 - ============ 2 - I2C topology 3 - ============ 1 + ================================ 2 + I2C muxes and complex topologies 3 + ================================ 4 4 5 5 There are a couple of reasons for building more complex I2C topologies 6 6 than a straight-forward I2C bus with one adapter and one or more devices.

+3 -3

Documentation/i2c/old-module-parameters.rst

··· 1 - ================================================= 2 - I2C device driver binding control from user-space 3 - ================================================= 1 + ================================================================ 2 + I2C device driver binding control from user-space in old kernels 3 + ================================================================ 4 4 5 5 .. NOTE:: 6 6 Note: this section is only relevant if you are handling some old code

+3 -3

Documentation/i2c/smbus-protocol.rst

··· 1 - ====================== 2 - SMBus Protocol Summary 3 - ====================== 1 + ================== 2 + The SMBus Protocol 3 + ================== 4 4 5 5 The following is a summary of the SMBus protocol. It applies to 6 6 all revisions of the protocol (1.0, 1.1, and 2.0).

+3 -3

Documentation/i2c/summary.rst

··· 1 - ============= 2 - I2C and SMBus 3 - ============= 1 + ============================= 2 + Introduction to I2C and SMBus 3 + ============================= 4 4 5 5 I²C (pronounce: I squared C and written I2C in the kernel documentation) is 6 6 a protocol developed by Philips. It is a slow two-wire protocol (variable

+3 -3

Documentation/i2c/writing-clients.rst

··· 1 - =================== 2 - Writing I2C Clients 3 - =================== 1 + =============================== 2 + Implementing I2C device drivers 3 + =============================== 4 4 5 5 This is a small guide for those who want to write kernel drivers for I2C 6 6 or SMBus devices, using Linux as the protocol host/master (not slave).