[PATCH v2 01/28] docs: i2c: sort index logically
From: Luca Ceresoli <luca@lucaceresoli.net>
Date: 2020-01-23 13:51:32
Also in:
linux-i2c, lkml
Subsystem:
i2c subsystem, the rest · Maintainers:
Andi Shyti, Linus Torvalds
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 <redacted> --- Changes in v2: - split sections in groups (suggested by Jean Delvare) - remove consecutive blank lines (reported by Jean Delvare) --- Documentation/i2c/index.rst | 59 ++++++++++++++++++++++++++++++------- 1 file changed, 48 insertions(+), 11 deletions(-)
diff --git a/Documentation/i2c/index.rst b/Documentation/i2c/index.rst
index a0fbaf6d0675..f0f3b9c97abb 100644
--- a/Documentation/i2c/index.rst
+++ b/Documentation/i2c/index.rst@@ -4,30 +4,67 @@ I2C/SMBus Subsystem =================== +Introduction +============ + +.. toctree:: + :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 dma-considerations fault-codes functionality + +Debugging +========= + +.. toctree:: + :maxdepth: 1 + gpio-fault-injection - i2c-protocol i2c-stub - i2c-topology - instantiating-devices - old-module-parameters - slave-eeprom-backend + +Slave I2C +========= + +.. toctree:: + :maxdepth: 1 + slave-interface - smbus-protocol - summary + slave-eeprom-backend + +Advanced topics +=============== + +.. toctree:: + :maxdepth: 1 + ten-bit-addresses - upgrading-clients - writing-clients - muxes/i2c-mux-gpio +Legacy documentation +==================== - busses/index +.. toctree:: + :maxdepth: 1 + + upgrading-clients + old-module-parameters .. only:: subproject and html
--
2.25.0