mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Costa Shulyupin <costa.shul@redhat.com>
To: Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org
Cc: Costa Shulyupin <costa.shul@redhat.com>,
	Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>,
	Akira Yokosawa <akiyks@gmail.com>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Thorsten Leemhuis <linux@leemhuis.info>,
	Lukas Bulwahn <lukas.bulwahn@gmail.com>,
	Rong Tao <rtoax@foxmail.com>,
	linux-kernel@vger.kernel.org (open list)
Subject: [PATCH] docs: split subtitle of Submitting patches
Date: Tue, 25 Apr 2023 10:26:43 +0300	[thread overview]
Message-ID: <20230425072644.868535-1-costa.shul@redhat.com> (raw)

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@redhat.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


             reply	other threads:[~2023-04-25  7:28 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-25  7:26 Costa Shulyupin [this message]
2023-05-30  1:20 ` Bagas Sanjaya
2023-05-30  8:52   ` Bagas Sanjaya

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230425072644.868535-1-costa.shul@redhat.com \
    --to=costa.shul@redhat.com \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=krzysztof.kozlowski@linaro.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@leemhuis.info \
    --cc=lukas.bulwahn@gmail.com \
    --cc=rtoax@foxmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®