linux-kernel - Re: [PATCH 7/9] docs: i2c: i2c-topology: reorder sections more logically

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

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <YvVwJf2s45yjUWfM@shikoro>
Date:   Thu, 11 Aug 2022 23:09:57 +0200
From:   Wolfram Sang <wsa@...nel.org>
To:     luca.ceresoli@...tlin.com, Peter Rosin <peda@...ntia.se>
Cc:     linux-doc@...r.kernel.org, linux-i2c@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH 7/9] docs: i2c: i2c-topology: reorder sections more
 logically

On Mon, Aug 08, 2022 at 04:17:06PM +0200, luca.ceresoli@...tlin.com wrote:
> From: Luca Ceresoli <luca.ceresoli@...tlin.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@...tlin.com>

Peter, are you fine with this change?


Download attachment "signature.asc" of type "application/pgp-signature" (834 bytes)