mbox series

[0/9] docs: i2c: rework I2C documentation, part II

Message ID 20220808141708.1021103-1-luca.ceresoli@bootlin.com
Headers show
Series docs: i2c: rework I2C documentation, part II | expand

Message

Luca Ceresoli Aug. 8, 2022, 2:16 p.m. UTC
From: Luca Ceresoli <luca.ceresoli@bootlin.com>

Back in January 2020 I sent a first batch of patches to improve I2C
documentation, titled "docs: i2c: rework I2C documentation, part I" [0] and
I wrote "I will continue to cover the rest of the sections later".

After about 2.5y, here I am with part II!

This series contains assorted improvements to the "Introduction"
section. The plan is to cover the remaining sections "later", but hopefully
sooner than in 2.5 more years.

[0] https://lore.kernel.org/linux-i2c/20200123135103.20540-1-luca@lucaceresoli.net/

Luca

Luca Ceresoli (9):
  docs: i2c: i2c-protocol: update introductory paragraph
  docs: i2c: i2c-protocol,smbus-protocol: remove nonsense words
  docs: i2c: i2c-protocol: remove unused legend items
  docs: i2c: smbus-protocol: improve DataLow/DataHigh definition
  docs: i2c: instantiating-devices: add syntax coloring to dts and C
    blocks
  docs: i2c: i2c-topology: fix incorrect heading
  docs: i2c: i2c-topology: reorder sections more logically
  docs: i2c: i2c-sysfs: improve wording
  docs: i2c: i2c-sysfs: fix hyperlinks

 Documentation/i2c/i2c-protocol.rst          |  11 +-
 Documentation/i2c/i2c-sysfs.rst             |  24 +--
 Documentation/i2c/i2c-topology.rst          | 209 ++++++++++----------
 Documentation/i2c/instantiating-devices.rst |  16 +-
 Documentation/i2c/smbus-protocol.rst        |   6 +-
 5 files changed, 137 insertions(+), 129 deletions(-)