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/[email protected]/
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@leemhuis.info/
* 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
--
2.40.1
* replace a needless sub-heading with a short intro sentence
* make "Following the submission" a proper sub-section with a headline
without changing the text of the section
CC: Greg KH <[email protected]>
CC: Sasha Levin <[email protected]>
CC: Jonathan Corbet <[email protected]>
Signed-off-by: Thorsten Leemhuis <[email protected]>
---
Documentation/process/stable-kernel-rules.rst | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/Documentation/process/stable-kernel-rules.rst b/Documentation/process/stable-kernel-rules.rst
index d3f040c2738e..e68a76abe44b 100644
--- a/Documentation/process/stable-kernel-rules.rst
+++ b/Documentation/process/stable-kernel-rules.rst
@@ -39,8 +39,7 @@ Procedure for submitting patches to the -stable tree
process but should follow the procedures in
:ref:`Documentation/process/security-bugs.rst <securitybugs>`.
-For all other submissions, choose one of the following procedures
------------------------------------------------------------------
+There are three options to submit a change to -stable trees:
.. _option_1:
@@ -153,13 +152,15 @@ problems:
Cc: <[email protected]> # see patch description, needs adjustments for >= 6.3
-Following the submission:
+Following the submission
+------------------------
- - The sender will receive an ACK when the patch has been accepted into the
- queue, or a NAK if the patch is rejected. This response might take a few
- days, according to the developer's schedules.
- - If accepted, the patch will be added to the -stable queue, for review by
- other developers and by the relevant subsystem maintainer.
+The sender will receive an ACK when the patch has been accepted into the
+queue, or a NAK if the patch is rejected. This response might take a few
+days, according to the developer's schedules.
+
+If accepted, the patch will be added to the -stable queue, for review by other
+developers and by the relevant subsystem maintainer.
Review cycle
--
2.40.1
Document that changes intended for a specific stable series have to be
in all newer series still maintained, as otherwise users would run into
regressions.
CC: Greg KH <[email protected]>
CC: Sasha Levin <[email protected]>
CC: Jonathan Corbet <[email protected]>
Signed-off-by: Thorsten Leemhuis <[email protected]>
---
Documentation/process/stable-kernel-rules.rst | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/Documentation/process/stable-kernel-rules.rst b/Documentation/process/stable-kernel-rules.rst
index 2b7f04211d9d..41f1e07abfdf 100644
--- a/Documentation/process/stable-kernel-rules.rst
+++ b/Documentation/process/stable-kernel-rules.rst
@@ -56,6 +56,12 @@ at the time of submission. :ref:`option_3` is an alternative to the two earlier
options for cases where a mainlined patch needs adjustments to apply in older
series (for example due to API changes).
+When using option 2 or 3 you can ask for your change to be included in specific
+stable series. When doing so, ensure the fix or an equivalent is applicable,
+submitted, or already present in all newer stable trees still supported. This is
+meant to prevent regressions that users might later encounter on updating, if
+e.g. a fix merged for 5.19-rc1 would be backported to 5.10.y, but not to 5.15.y.
+
.. _option_1:
Option 1
@@ -133,7 +139,7 @@ Option 2
If the patch already has been merged to mainline, send an email to
[email protected] containing the subject of the patch, the commit ID,
-why you think it should be applied, and what kernel version you wish it to
+why you think it should be applied, and what kernel versions you wish it to
be applied to.
.. _option_3:
@@ -142,7 +148,7 @@ Option 3
********
Send the patch, after verifying that it follows the above rules, to
[email protected] and mention the kernel version you wish it to be applied
[email protected] and mention the kernel versions you wish it to be applied
to. When doing so, you must note the upstream commit ID in the changelog of your
submission with a separate line above the commit text, like this:
--
2.40.1