docs: i2c: sort index logically
The index page currently lists sections in alphabetical file order without caring about their content. Sort sections based on their content logically, according to the following structure: * Intro to I2C/SMBus and their usage in Linux: summary, i2c-protocol, smbus-protocol, instantiating-devices, busses/index, i2c-topology, muxes/i2c-mux-gpio * Implementing drivers: writing-clients, dev-interface, dma-considerations, fault-codes, functionality * Debugging: gpio-fault-injection, i2c-stub * Slave I2C: slave-interface, slave-eeprom-backend * Advanced: ten-bit-addresses * Obsolete info: upgrading-clients, old-module-parameters Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Reviewed-by: Jean Delvare <jdelvare@suse.de> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
This commit is contained in:
parent
4a890148df
commit
2159393808
|
@ -4,30 +4,66 @@
|
||||||
I2C/SMBus Subsystem
|
I2C/SMBus Subsystem
|
||||||
===================
|
===================
|
||||||
|
|
||||||
|
Introduction
|
||||||
|
============
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
|
summary
|
||||||
|
i2c-protocol
|
||||||
|
smbus-protocol
|
||||||
|
instantiating-devices
|
||||||
|
busses/index
|
||||||
|
i2c-topology
|
||||||
|
muxes/i2c-mux-gpio
|
||||||
|
|
||||||
|
Writing device drivers
|
||||||
|
======================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
writing-clients
|
||||||
dev-interface
|
dev-interface
|
||||||
dma-considerations
|
dma-considerations
|
||||||
fault-codes
|
fault-codes
|
||||||
functionality
|
functionality
|
||||||
|
|
||||||
|
Debugging
|
||||||
|
=========
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
gpio-fault-injection
|
gpio-fault-injection
|
||||||
i2c-protocol
|
|
||||||
i2c-stub
|
i2c-stub
|
||||||
i2c-topology
|
|
||||||
instantiating-devices
|
Slave I2C
|
||||||
old-module-parameters
|
=========
|
||||||
slave-eeprom-backend
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
slave-interface
|
slave-interface
|
||||||
smbus-protocol
|
slave-eeprom-backend
|
||||||
summary
|
|
||||||
|
Advanced topics
|
||||||
|
===============
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
ten-bit-addresses
|
ten-bit-addresses
|
||||||
|
|
||||||
|
Legacy documentation
|
||||||
|
====================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
upgrading-clients
|
upgrading-clients
|
||||||
writing-clients
|
old-module-parameters
|
||||||
|
|
||||||
muxes/i2c-mux-gpio
|
|
||||||
|
|
||||||
busses/index
|
|
||||||
|
|
||||||
.. only:: subproject and html
|
.. only:: subproject and html
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue