| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-Id: <20200129151953.31582-1-luca@lucaceresoli.net>
Date: Wed, 29 Jan 2020 16:19:25 +0100
From: Luca Ceresoli <luca@...aceresoli.net>
To: linux-i2c@...r.kernel.org, linux-doc@...r.kernel.org
Cc: Luca Ceresoli <luca@...aceresoli.net>,
Wolfram Sang <wsa@...-dreams.de>,
Jean Delvare <jdelvare@...e.de>, Peter Rosin <peda@...ntia.se>,
linux-kernel@...r.kernel.org
Subject: [PATCH v3 00/28] docs: i2c: rework I2C documentation, part I
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 and some cross-section changes.
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. 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.
v2 and v3 incorporate many improvements suggested by Jean Delvare and Peter
Rosin. A special thank you to Jean for his very patient and appreciated
review work of _all_ of the 26 patches. Thanks to his work the patches are
now 28. :) Patches 27 and 28 are the new ones.
Luca
Luca Ceresoli (28):
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-protocol: 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: smbus-protocol: fix typo
docs: i2c: smbus-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 sysfs attributes
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 instead of ""
docs: i2c: rename sections so the overall picture is clearer
docs: i2c: i2c-protocol: use same wording as smbus-protocol
docs: i2c: writing-clients: properly name the stop condition
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 | 58 +-
Documentation/i2c/instantiating-devices.rst | 115 +-
Documentation/i2c/old-module-parameters.rst | 31 +-
Documentation/i2c/slave-interface.rst | 4 +-
Documentation/i2c/smbus-protocol.rst | 107 +-
Documentation/i2c/summary.rst | 62 +-
Documentation/i2c/writing-clients.rst | 16 +-
12 files changed, 1653 insertions(+), 224 deletions(-)
create mode 100644 Documentation/i2c/i2c.svg
--
2.25.0
Powered by blists - more mailing lists