davidlt/kernel-ark
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source 
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>
This commit is contained in:
Luca Ceresoli 2020-01-29 16:19:51 +01:00 committed by Wolfram Sang
parent 1ef0572296
commit f6fcefa10f
7 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/i2c/dev-interface.rst
View 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

6
Documentation/i2c/i2c-protocol.rst
View File

@ -1,6 +1,6 @@
============
I2C Protocol
============
================
The I2C Protocol
================
This document describes the I2C protocol. Or will, when it is finished :-)

6
Documentation/i2c/i2c-topology.rst
View 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.

6
Documentation/i2c/old-module-parameters.rst
View 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

6
Documentation/i2c/smbus-protocol.rst
View 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).

6
Documentation/i2c/summary.rst
View 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

6
Documentation/i2c/writing-clients.rst
View 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).