Hi, this series is a list of improvements to the I2C documentation. It started as a simple reordering of index.rst from alphabetical order to a logical order. Then it grew to a mixture of various improvements to each section. I wanted to rework all the sections in a unique series, but after covering about one third of them the number of patches has already grown pretty long so I'm sending it in its current state. Let's see how this series is received, I will continue to cover the rest of the sections later. Each patch is quite self-standing, and most are trivial, so have a good reading. Luca Luca Ceresoli (26): docs: i2c: sort index logically docs: i2c: summary: extend introduction docs: i2c: summary: rewrite the "terminology" section docs: i2c: call it "I2C" consistently docs: i2c: fix typo docs: i2c: replace "I2C-transfer" -> "I2C transfer" consistently docs: i2c: i2c-protocol: fix kernel-doc function syntax docs: i2c: i2c-protocol: properly name start and stop conditions docs: i2c: i2c-protocol: remove unneeded colons from table docs: i2c: i2c-protocol: use proper names for ACK and NACK docs: i2c: smbus: fix link syntax docs: i2c: smbus-protocol: properly name start and stop conditions docs: i2c: smbus-protocol: remove unneeded colons from table docs: i2c: smbus-protocol: use proper names for ACK and NACK docs: i2c: smbus-protocol: enable kernel-doc function syntax docs: i2c: smbus-protocol: fix kernel-doc function syntax docs: i2c: i2c-protocol: fix typo docs: i2c: i2c-protocol: fix punctuation docs: i2c: smbus-protocol: improve I2C Block transactions description docs: i2c: instantiating-devices: fix internal hyperlink docs: i2c: instantiating-devices: rearrange static instatiation docs: i2c: instantiating-devices: use monospace for filenames docs: i2c: old-module-parameters: fix internal hyperlink docs: i2c: old-module-parameters: clarify this is for obsolete kernels docs: i2c: old-module-parameters: use monospace for filenames docs: i2c: rename sections so the overall picture is clearer Documentation/i2c/dev-interface.rst | 24 +- Documentation/i2c/dma-considerations.rst | 2 +- Documentation/i2c/i2c-protocol.rst | 45 +- Documentation/i2c/i2c-topology.rst | 72 +- Documentation/i2c/i2c.svg | 1341 +++++++++++++++++++ Documentation/i2c/index.rst | 21 +- Documentation/i2c/instantiating-devices.rst | 116 +- Documentation/i2c/old-module-parameters.rst | 30 +- Documentation/i2c/slave-interface.rst | 4 +- Documentation/i2c/smbus-protocol.rst | 107 +- Documentation/i2c/summary.rst | 61 +- Documentation/i2c/writing-clients.rst | 10 +- 12 files changed, 1611 insertions(+), 222 deletions(-) create mode 100644 Documentation/i2c/i2c.svg -- 2.24.1
