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

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>

authored by

Luca Ceresoli and committed by
Wolfram Sang
21593938 4a890148

+48 -12
+48 -12
Documentation/i2c/index.rst
··· 4 4 I2C/SMBus Subsystem 5 5 =================== 6 6 7 + Introduction 8 + ============ 9 + 7 10 .. toctree:: 8 11 :maxdepth: 1 9 12 13 + summary 14 + i2c-protocol 15 + smbus-protocol 16 + instantiating-devices 17 + busses/index 18 + i2c-topology 19 + muxes/i2c-mux-gpio 20 + 21 + Writing device drivers 22 + ====================== 23 + 24 + .. toctree:: 25 + :maxdepth: 1 26 + 27 + writing-clients 10 28 dev-interface 11 29 dma-considerations 12 30 fault-codes 13 31 functionality 32 + 33 + Debugging 34 + ========= 35 + 36 + .. toctree:: 37 + :maxdepth: 1 38 + 14 39 gpio-fault-injection 15 - i2c-protocol 16 40 i2c-stub 17 - i2c-topology 18 - instantiating-devices 19 - old-module-parameters 20 - slave-eeprom-backend 41 + 42 + Slave I2C 43 + ========= 44 + 45 + .. toctree:: 46 + :maxdepth: 1 47 + 21 48 slave-interface 22 - smbus-protocol 23 - summary 49 + slave-eeprom-backend 50 + 51 + Advanced topics 52 + =============== 53 + 54 + .. toctree:: 55 + :maxdepth: 1 56 + 24 57 ten-bit-addresses 58 + 59 + Legacy documentation 60 + ==================== 61 + 62 + .. toctree:: 63 + :maxdepth: 1 64 + 25 65 upgrading-clients 26 - writing-clients 27 - 28 - muxes/i2c-mux-gpio 29 - 30 - busses/index 66 + old-module-parameters 31 67 32 68 .. only:: subproject and html 33 69