linux-kernel - [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-next>] [day] [month] [year] [list]

Message-Id: <20230425072644.868535-1-costa.shul@redhat.com>
Date:   Tue, 25 Apr 2023 10:26:43 +0300
From:   Costa Shulyupin <costa.shul@...hat.com>
To:     Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org
Cc:     Costa Shulyupin <costa.shul@...hat.com>,
        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>,
        linux-kernel@...r.kernel.org (open list)
Subject: [PATCH] docs: split subtitle of Submitting patches

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

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

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.


Signed-off-by: Costa Shulyupin <costa.shul@...hat.com>
---
 Documentation/process/submitting-patches.rst | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index 7a5619fecb38..051eba1bbc7f 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -1,7 +1,10 @@
 .. _submittingpatches:
 
-Submitting patches: the essential guide to getting your code into the kernel
-============================================================================
+Submitting patches
+==================
+The essential guide to getting your code into the kernel
+
+|
 
 For a person or company who wishes to submit a change to the Linux
 kernel, the process can sometimes be daunting if you're not familiar
-- 
2.40.0