linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 00/26] docs: i2c: rework I2C documentation, part I
@ 2020-01-05 22:39 Luca Ceresoli
  2020-01-05 22:49 ` [PATCH 01/26] docs: i2c: sort index logically Luca Ceresoli
                   ` (4 more replies)
  0 siblings, 5 replies; 72+ messages in thread
From: Luca Ceresoli @ 2020-01-05 22:39 UTC (permalink / raw)
  To: linux-doc, linux-i2c
  Cc: Luca Ceresoli, Wolfram Sang, Peter Rosin, linux-kernel

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


^ permalink raw reply	[flat|nested] 72+ messages in thread

end of thread, other threads:[~2020-01-23  9:51 UTC | newest]

Thread overview: 72+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-01-05 22:39 [PATCH 00/26] docs: i2c: rework I2C documentation, part I Luca Ceresoli
2020-01-05 22:49 ` [PATCH 01/26] docs: i2c: sort index logically Luca Ceresoli
2020-01-05 22:49   ` [PATCH 02/26] docs: i2c: summary: extend introduction Luca Ceresoli
2020-01-20  9:27     ` Jean Delvare
2020-01-20 21:54       ` Luca Ceresoli
2020-01-05 22:49   ` [PATCH 03/26] docs: i2c: summary: rewrite the "terminology" section Luca Ceresoli
2020-01-20 10:04     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 04/26] docs: i2c: call it "I2C" consistently Luca Ceresoli
2020-01-07 10:33     ` Peter Rosin
2020-01-16  9:39     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 05/26] docs: i2c: fix typo Luca Ceresoli
2020-01-07 10:33     ` Peter Rosin
2020-01-16  9:40     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 06/26] docs: i2c: replace "I2C-transfer" -> "I2C transfer" consistently Luca Ceresoli
2020-01-07 10:34     ` Peter Rosin
2020-01-20 10:07     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 07/26] docs: i2c: i2c-protocol: fix kernel-doc function syntax Luca Ceresoli
2020-01-20 10:51     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 08/26] docs: i2c: i2c-protocol: properly name start and stop conditions Luca Ceresoli
2020-01-20 12:49     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 09/26] docs: i2c: i2c-protocol: remove unneeded colons from table Luca Ceresoli
2020-01-20 13:38     ` Jean Delvare
2020-01-20 14:22       ` Jean Delvare
2020-01-05 22:49   ` [PATCH 10/26] docs: i2c: i2c-protocol: use proper names for ACK and NACK Luca Ceresoli
2020-01-20 13:50     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 11/26] docs: i2c: smbus: fix link syntax Luca Ceresoli
2020-01-20 14:10     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 12/26] docs: i2c: smbus-protocol: properly name start and stop conditions Luca Ceresoli
2020-01-20 14:16     ` Jean Delvare
2020-01-05 22:49   ` [PATCH 13/26] docs: i2c: smbus-protocol: remove unneeded colons from table Luca Ceresoli
2020-01-20 14:23     ` Jean Delvare
2020-01-05 22:50   ` [PATCH 14/26] docs: i2c: smbus-protocol: use proper names for ACK and NACK Luca Ceresoli
2020-01-20 14:26     ` Jean Delvare
2020-01-05 22:50   ` [PATCH 15/26] docs: i2c: smbus-protocol: enable kernel-doc function syntax Luca Ceresoli
2020-01-20 14:44     ` Jean Delvare
2020-01-21 17:31       ` Luca Ceresoli
2020-01-22 11:48         ` Jean Delvare
2020-01-23  9:51           ` Luca Ceresoli
2020-01-22 14:26         ` Jean Delvare
2020-01-22 15:37           ` Wolfram Sang
2020-01-23  9:51             ` Luca Ceresoli
2020-01-05 22:50   ` [PATCH 16/26] docs: i2c: smbus-protocol: fix " Luca Ceresoli
2020-01-20 14:51     ` Jean Delvare
2020-01-05 22:50   ` [PATCH 17/26] docs: i2c: i2c-protocol: fix typo Luca Ceresoli
2020-01-20 15:15     ` Jean Delvare
2020-01-05 22:50   ` [PATCH 18/26] docs: i2c: i2c-protocol: fix punctuation Luca Ceresoli
2020-01-20 15:16     ` Jean Delvare
2020-01-05 22:50   ` [PATCH 19/26] docs: i2c: smbus-protocol: improve I2C Block transactions description Luca Ceresoli
2020-01-21  9:16     ` Jean Delvare
2020-01-05 22:50   ` [PATCH 20/26] docs: i2c: instantiating-devices: fix internal hyperlink Luca Ceresoli
2020-01-21 10:07     ` Jean Delvare
2020-01-05 22:50   ` [PATCH 21/26] docs: i2c: instantiating-devices: rearrange static instatiation Luca Ceresoli
2020-01-21 18:02     ` Jean Delvare
2020-01-23  9:51       ` Luca Ceresoli
2020-01-05 22:50   ` [PATCH 22/26] docs: i2c: instantiating-devices: use monospace for filenames Luca Ceresoli
2020-01-22 10:08     ` Jean Delvare
2020-01-05 22:50   ` [PATCH 23/26] docs: i2c: old-module-parameters: fix internal hyperlink Luca Ceresoli
2020-01-22 10:16     ` Jean Delvare
2020-01-23  9:50       ` Luca Ceresoli
2020-01-20  9:08   ` [PATCH 01/26] docs: i2c: sort index logically Jean Delvare
2020-01-20  9:22     ` Luca Ceresoli
2020-01-20 13:56       ` Luca Ceresoli
2020-01-06  7:46 ` [PATCH 24/26] docs: i2c: old-module-parameters: clarify this is for obsolete kernels Luca Ceresoli
2020-01-22 11:18   ` Jean Delvare
2020-01-06  7:46 ` [PATCH 25/26] docs: i2c: old-module-parameters: use monospace for filenames Luca Ceresoli
2020-01-22 11:45   ` Jean Delvare
2020-01-06  7:49 ` [PATCH 26/26] docs: i2c: rename sections so the overall picture is clearer Luca Ceresoli
2020-01-07 10:36   ` Peter Rosin
2020-01-16  9:49   ` Jean Delvare
2020-01-16 10:38     ` Luca Ceresoli
2020-01-16 13:34       ` Peter Rosin
2020-01-06  8:03 ` [PATCH 00/26] docs: i2c: rework I2C documentation, part I Luca Ceresoli

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).