From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.2 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_SANE_1 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0BE71C33CB7 for ; Mon, 20 Jan 2020 09:22:12 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id E0D122073A for ; Mon, 20 Jan 2020 09:22:11 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727114AbgATJWL (ORCPT ); Mon, 20 Jan 2020 04:22:11 -0500 Received: from hostingweb31-40.netsons.net ([89.40.174.40]:50742 "EHLO hostingweb31-40.netsons.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726130AbgATJWK (ORCPT ); Mon, 20 Jan 2020 04:22:10 -0500 Received: from [109.168.11.45] (port=44750 helo=[192.168.101.73]) by hostingweb31.netsons.net with esmtpsa (TLSv1.2:ECDHE-RSA-AES128-GCM-SHA256:128) (Exim 4.92) (envelope-from ) id 1itTG3-0002nT-E3; Mon, 20 Jan 2020 10:22:07 +0100 Subject: Re: [PATCH 01/26] docs: i2c: sort index logically To: Jean Delvare Cc: linux-doc@vger.kernel.org, linux-i2c@vger.kernel.org, Wolfram Sang , Peter Rosin , linux-kernel@vger.kernel.org References: <20200105224006.10321-1-luca@lucaceresoli.net> <20200105225012.11701-1-luca@lucaceresoli.net> <20200120100850.001e032b@endymion> From: Luca Ceresoli Message-ID: Date: Mon, 20 Jan 2020 10:22:07 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.2.2 MIME-Version: 1.0 In-Reply-To: <20200120100850.001e032b@endymion> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - hostingweb31.netsons.net X-AntiAbuse: Original Domain - vger.kernel.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - lucaceresoli.net X-Get-Message-Sender-Via: hostingweb31.netsons.net: authenticated_id: luca+lucaceresoli.net/only user confirmed/virtual account not confirmed X-Authenticated-Sender: hostingweb31.netsons.net: luca@lucaceresoli.net X-Source: X-Source-Args: X-Source-Dir: Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hi Jean, On 20/01/20 10:08, Jean Delvare wrote: > Hi Luca, > > On Sun, 5 Jan 2020 23:49:47 +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 > > Good idea. I wonder, would there be a way to materialize these group > names in the documentation itself? I found it useful when reviewing the > patch, but in the long term it would be even more useful if the end > readers would see them too. I had the same idea, but didn't find an obvious way to do it with the ReST/Sphynx syntax. I have also browsed through a few index pages for other subsystems and they all have a flat list too, so for the moment I gave up. Anybody has hints on how to do this in a clean way? >> diff --git a/Documentation/i2c/index.rst b/Documentation/i2c/index.rst >> index a0fbaf6d0675..bd0ff9d00793 100644 >> --- a/Documentation/i2c/index.rst >> +++ b/Documentation/i2c/index.rst >> @@ -7,27 +7,26 @@ I2C/SMBus Subsystem >> .. toctree:: >> :maxdepth: 1 >> >> + summary >> + i2c-protocol >> + smbus-protocol >> + instantiating-devices >> + busses/index >> + i2c-topology >> + muxes/i2c-mux-gpio >> + writing-clients >> dev-interface >> dma-considerations >> fault-codes >> functionality >> gpio-fault-injection >> - i2c-protocol >> i2c-stub >> - i2c-topology >> - instantiating-devices >> - old-module-parameters >> - slave-eeprom-backend >> slave-interface >> - smbus-protocol >> - summary >> + slave-eeprom-backend >> ten-bit-addresses >> upgrading-clients >> - writing-clients >> - >> - muxes/i2c-mux-gpio >> + old-module-parameters >> >> - busses/index >> > > You end up with 2 blank lines in a row here, ideally there should be > only one left. Good catch, thanks, will fix in v2. -- Luca