docs: i2c: i2c-topology: reorder sections more logically
authorLuca Ceresoli <luca.ceresoli@bootlin.com>
Wed, 24 Aug 2022 08:31:04 +0000 (10:31 +0200)
committerWolfram Sang <wsa@kernel.org>
Mon, 29 Aug 2022 10:28:13 +0000 (12:28 +0200)
commit92d5d6434d285510a3563ebace24306e240615e1
tree65083dd82943190da1c7e5cccef9153ff82e60e2
parent12c035a1a840e07a351c277d7a468269fa603000
docs: i2c: i2c-topology: reorder sections more logically

The sequence of sections is a bit confusing here:

 * we list the mux locking scheme for existing drivers before introducing
   what mux locking schemes are
 * we list the caveats for each locking scheme (which are tricky) before
   the example of the simple use case

Restructure it entirely with the following logic:

 * Intro ("I2C muxes and complex topologies")
 * Locking
   - mux-locked
     - example
     - caveats
   - parent-locked
     - example
     - caveats
 * Complex examples
 * Mux type of existing device drivers

While there, also apply some other improvements:

 * convert the caveat list from a table (with only one column carrying
   content) to a bullet list.
 * add a small introductory text to bridge the gap from listing the use
   cases to telling about the hardware components to handle them and then
   the device drivers that implement those.
 * make empty lines usage more uniform

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Acked-by: Peter Rosin <peda@axentia.se>
Signed-off-by: Wolfram Sang <wsa@kernel.org>
Documentation/i2c/i2c-topology.rst