Re: [PATCH v1 0/5] docs: stable-kernel-rules: improve structure and a few tweaks

[Thorsten Leemhuis]

[adding Sasha and Jon to the CC, seem I forget to do that on the cover
letter; sorry!]

On 05.08.23 09:21, Thorsten Leemhuis wrote:
> When adding something to this document earlier I noticed that readers
> need to perform some back and forth to fully understand things; I also
> noticed a few other aspects that seemed somewhat odd for me with my
> background on writing and editing texts.
> 
> Find attached a few patches to improve things. The first three are
> mainly moving text around to a structure which is somewhat clearer. They
> leave quite a few rough edges behind that are fixed in in the last patch
> of the series, which changes a few other changes as well; thx to the
> prep patches the diff should be relative straight-forward to understand.
> 
> These patches are on-top of the following series that currently is in the 
> driver-core-testing branch:
> https://lore.kernel.org/all/cover.1689056247.git.linux@xxxxxxxxxxxxx/

FWIW, in case anyone wonders how the text looks in the end, see:

https://www.leemhuis.info/files/kernel/stable-rules/stable-kernel-rules.txt

https://www.leemhuis.info/files/kernel/stable-rules/Everything%20you%20ever%20wanted%20to%20know%20about%20Linux%20-stable%20releases%20%e2%80%94%20The%20Linux%20Kernel%20documentation.html

Ciao, Thorsten

> v1:
> * new patch-set based on patch 3/3 and other feedback to the following
>   patchset[1], but slit off into a seperate set with four distinct
>   patches to make it easier to see what is actually changed
>   https://lore.kernel.org/linux-doc/d30686781c47c83927e0a41f6a1167a679fa822c.1689008220.git.linux@xxxxxxxxxxxxx/
> * append one more patch for something that came up
> 
> Thorsten Leemhuis (5):
>   docs: stable-kernel-rules: improve structure by changing headlines
>   docs: stable-kernel-rules: move text around to improve flow
>   docs: stable-kernel-rules: make the examples for option 1 a proper
>     list
>   docs: stable-kernel-rules: fine-tune various details
>   docs: stable-kernel-rules: mention that regressions must be prevented
> 
>  Documentation/process/stable-kernel-rules.rst | 165 ++++++++++--------
>  1 file changed, 91 insertions(+), 74 deletions(-)
> 
> 
> base-commit: 016571b6d52deb473676fb4d24baf8ed3667ae21
> prerequisite-patch-id: b00970f680f3032fe8a7d0e3843b76d60c2f0458
> prerequisite-patch-id: 9926a13726e99d51800f52cb84e26ae971757467