Re: [PATCH v2 01/28] docs: i2c: sort index logically

From: Luca Ceresoli
Date: Wed Jan 29 2020 - 07:22:39 EST


Hi Jean,

On 24/01/20 13:35, Jean Delvare wrote:
> 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@xxxxxxxxxxxxxxxx>
>> Reviewed-by: Jean Delvare <jdelvare@xxxxxxx>
>>
>> ---
>>
>> 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?

It's not intended. Thanks for double checking!

I fixed this patch as well as patch 11. v3 on its way.

--
Luca