2023-04-25 07:30:29

by Costa Shulyupin

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 <[email protected]>
---
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

2023-05-30 02:09:05

by Bagas Sanjaya

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

2023-05-30 09:30:45

by Bagas Sanjaya

Subject: Re: [PATCH] docs: split subtitle of Submitting patches

On 5/30/23 08:20, Bagas Sanjaya wrote:
> 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.
>

Oops, I mean it's perfectly OK to have long title written as-is if it
can't be further condensed to convey the doc theme.

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