linux-kernel - Re: [PATCH] docs: split subtitle of Submitting patches

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: <f569e819-9391-0a52-fcda-24946687690d@gmail.com>
Date:   Tue, 30 May 2023 08:20:39 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     Costa Shulyupin <costa.shul@...hat.com>,
        Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org
Cc:     Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>,
        Akira Yokosawa <akiyks@...il.com>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Thorsten Leemhuis <linux@...mhuis.info>,
        Lukas Bulwahn <lukas.bulwahn@...il.com>,
        Rong Tao <rtoax@...mail.com>,
        open list <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] docs: split subtitle of Submitting patches

On 4/25/23 14:26, Costa Shulyupin wrote:
> Motivation:
> 
> The original long page title in the left Content pane spans three lines:
> 
> Submitting patches: the essential
>   guide to getting your code into
>   the kernel
> 

I think it's OK to have that, if the title can't be further condensed.

> Issues:
> - It is not readable.
> - It further inflates already overpopulated Contents pane.
> 

table of contents?

> The solution:
> - Split the long title to title and subtitle.
> - Vertical bar '|' in Sphinx-doc introduces empty line to
>   make the subtitle closer to the title than to the following text.
> 

Nope.

The title (as a whole) is already descriptive enough for
describing the text.

Thanks.

-- 
An old man doll... just what I always wanted! - Clara