linux-kernel - Re: [PATCH v2 01/28] docs: i2c: sort index 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: <20200124133548.7f01344a@endymion>
Date:   Fri, 24 Jan 2020 13:35:48 +0100
From:   Jean Delvare <jdelvare@...e.de>
To:     Luca Ceresoli <luca@...aceresoli.net>
Cc:     linux-i2c@...r.kernel.org, linux-doc@...r.kernel.org,
        Wolfram Sang <wsa@...-dreams.de>,
        Peter Rosin <peda@...ntia.se>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 01/28] docs: i2c: sort index logically

On Thu, 23 Jan 2020 14:50:36 +0100, Luca Ceresoli wrote:
> The index page currently lists sections in alphabetical file order without
> caring about their content. Sort sections based on their content logically,
> according to the following structure:
> 
>  * Intro to I2C/SMBus and their usage in Linux: summary, i2c-protocol,
>    smbus-protocol, instantiating-devices, busses/index, i2c-topology,
>    muxes/i2c-mux-gpio
>  * Implementing drivers: writing-clients, dev-interface,
>    dma-considerations, fault-codes, functionality
>  * Debugging: gpio-fault-injection, i2c-stub
>  * Slave I2C: slave-interface, slave-eeprom-backend
>  * Advanced: ten-bit-addresses
>  * Obsolete info: upgrading-clients, old-module-parameters
> 
> Signed-off-by: Luca Ceresoli <luca@...aceresoli.net>
> Reviewed-by: Jean Delvare <jdelvare@...e.de>
> 
> ---
> 
> Changes in v2:
>  - split sections in groups (suggested by Jean Delvare)
>  - remove consecutive blank lines (reported by Jean Delvare)
> ---
>  Documentation/i2c/index.rst | 59 ++++++++++++++++++++++++++++++-------
>  1 file changed, 48 insertions(+), 11 deletions(-)
> 
> diff --git a/Documentation/i2c/index.rst b/Documentation/i2c/index.rst
> index a0fbaf6d0675..f0f3b9c97abb 100644
> --- a/Documentation/i2c/index.rst
> +++ b/Documentation/i2c/index.rst
> @@ -4,30 +4,67 @@
>  I2C/SMBus Subsystem
>  ===================
>  
> +Introduction
> +============
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   summary
> +   i2c-protocol
> +   smbus-protocol
> +   instantiating-devices
> +   busses/index
> +   i2c-topology
> +   muxes/i2c-mux-gpio
> +
> +

You still have a double blank line here, not sure if this is intended?

Looks good otherwise.

Reviewed-by: Jean Delvare <jdelvare@...e.de>

> +Writing device drivers
> +======================
> +
>  .. toctree::
>     :maxdepth: 1
>  
> +   writing-clients
>     dev-interface
>     dma-considerations
>     fault-codes
>     functionality
> +
> +Debugging
> +=========
> +
> +.. toctree::
> +   :maxdepth: 1
> +
>     gpio-fault-injection
> -   i2c-protocol
>     i2c-stub
> -   i2c-topology
> -   instantiating-devices
> -   old-module-parameters
> -   slave-eeprom-backend
> +
> +Slave I2C
> +=========
> +
> +.. toctree::
> +   :maxdepth: 1
> +
>     slave-interface
> -   smbus-protocol
> -   summary
> +   slave-eeprom-backend
> +
> +Advanced topics
> +===============
> +
> +.. toctree::
> +   :maxdepth: 1
> +
>     ten-bit-addresses
> -   upgrading-clients
> -   writing-clients
>  
> -   muxes/i2c-mux-gpio
> +Legacy documentation
> +====================
>  
> -   busses/index
> +.. toctree::
> +   :maxdepth: 1
> +
> +   upgrading-clients
> +   old-module-parameters
>  
>  .. only::  subproject and html
>  


-- 
Jean Delvare
SUSE L3 Support