From: Wolfram Sang <wsa@kernel.org>
To: luca.ceresoli@bootlin.com
Cc: linux-doc@vger.kernel.org, linux-i2c@vger.kernel.org,
Peter Rosin <peda@axentia.se>,
linux-kernel@vger.kernel.org,
Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: Re: [PATCH v3 3/3] docs: i2c: i2c-topology: reorder sections more logically
Date: Thu, 25 Aug 2022 09:42:45 +0200 [thread overview]
Message-ID: <Ywcn9Rz887L69yS8@shikoro> (raw)
In-Reply-To: <20220824083104.2267000-4-luca.ceresoli@bootlin.com>
[-- Attachment #1: Type: text/plain, Size: 1275 bytes --]
On Wed, Aug 24, 2022 at 10:31:04AM +0200, luca.ceresoli@bootlin.com wrote:
> From: Luca Ceresoli <luca.ceresoli@bootlin.com>
>
> 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>
>
Applied to for-current, thanks!
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
prev parent reply other threads:[~2022-08-25 7:43 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-24 8:31 [PATCH v3 0/3] docs: i2c: rework I2C documentation, part II luca.ceresoli
2022-08-24 8:31 ` [PATCH v3 1/3] docs: i2c: i2c-topology: fix typo luca.ceresoli
2022-08-25 7:42 ` Wolfram Sang
2022-08-24 8:31 ` [PATCH v3 2/3] docs: i2c: i2c-topology: fix incorrect heading luca.ceresoli
2022-08-25 7:42 ` Wolfram Sang
2022-08-24 8:31 ` [PATCH v3 3/3] docs: i2c: i2c-topology: reorder sections more logically luca.ceresoli
2022-08-25 7:42 ` Wolfram Sang [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=Ywcn9Rz887L69yS8@shikoro \
--to=wsa@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-i2c@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=luca.ceresoli@bootlin.com \
--cc=peda@axentia.se \
--cc=thomas.petazzoni@bootlin.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.