Skip to content

Commit 3feb21b

Browse files
knurdgregkh
authored andcommitted
docs: stable-kernel-rules: move text around to improve flow
Move the short description about when to use which of the submission options to the top of the section, as it currently sits somewhat odd in the middle between option 3 and examples of option 1. Also move the examples of Option 1 into the section describing it (which in the diff looks like option 2 and 3 are moving down). No text changes, just moving it around. CC: Greg KH <[email protected]> CC: Sasha Levin <[email protected]> CC: Jonathan Corbet <[email protected]> Signed-off-by: Thorsten Leemhuis <[email protected]> Link: https://lore.kernel.org/r/16f2377ee40dd7dfa146727fcbe7d1ebccf5b5be.1691219455.git.linux@leemhuis.info Signed-off-by: Greg Kroah-Hartman <[email protected]>
1 parent 0f11447 commit 3feb21b

File tree

1 file changed

+44
-44
lines changed

1 file changed

+44
-44
lines changed

Documentation/process/stable-kernel-rules.rst

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,13 @@ Procedure for submitting patches to the -stable tree
4141

4242
There are three options to submit a change to -stable trees:
4343

44+
:ref:`option_1` is **strongly** preferred, is the easiest and most common.
45+
:ref:`option_2` and :ref:`option_3` are more useful if the patch isn't deemed
46+
worthy at the time it is applied to a public git tree (for instance, because
47+
it deserves more regression testing first). :ref:`option_3` is especially
48+
useful if the original upstream patch needs to be backported (for example
49+
the backport needs some special handling due to e.g. API changes).
50+
4451
.. _option_1:
4552

4653
Option 1
@@ -57,50 +64,6 @@ inline comment (see below for details). Once the patch is merged it will be
5764
applied to the stable tree without anything else needing to be done by the
5865
author or subsystem maintainer.
5966

60-
.. _option_2:
61-
62-
Option 2
63-
********
64-
65-
After the patch has been merged to Linus' tree, send an email to
66-
[email protected] containing the subject of the patch, the commit ID,
67-
why you think it should be applied, and what kernel version you wish it to
68-
be applied to.
69-
70-
.. _option_3:
71-
72-
Option 3
73-
********
74-
75-
Send the patch, after verifying that it follows the above rules, to
76-
[email protected]. You must note the upstream commit ID in the
77-
changelog of your submission, as well as the kernel version you wish
78-
it to be applied to.
79-
80-
:ref:`option_1` is **strongly** preferred, is the easiest and most common.
81-
:ref:`option_2` and :ref:`option_3` are more useful if the patch isn't deemed
82-
worthy at the time it is applied to a public git tree (for instance, because
83-
it deserves more regression testing first). :ref:`option_3` is especially
84-
useful if the original upstream patch needs to be backported (for example
85-
the backport needs some special handling due to e.g. API changes).
86-
87-
Note that for :ref:`option_3`, if the patch deviates from the original
88-
upstream patch (for example because it had to be backported) this must be very
89-
clearly documented and justified in the patch description.
90-
91-
The upstream commit ID must be specified with a separate line above the commit
92-
text, like this:
93-
94-
.. code-block:: none
95-
96-
commit <sha1> upstream.
97-
98-
or alternatively:
99-
100-
.. code-block:: none
101-
102-
[ Upstream commit <sha1> ]
103-
10467
Additionally, some patches submitted via :ref:`option_1` may have additional
10568
patch prerequisites which can be cherry-picked. This can be specified in the
10669
following format in the sign-off area:
@@ -152,6 +115,43 @@ problems:
152115
153116
Cc: <[email protected]> # see patch description, needs adjustments for >= 6.3
154117
118+
.. _option_2:
119+
120+
Option 2
121+
********
122+
123+
After the patch has been merged to Linus' tree, send an email to
124+
[email protected] containing the subject of the patch, the commit ID,
125+
why you think it should be applied, and what kernel version you wish it to
126+
be applied to.
127+
128+
.. _option_3:
129+
130+
Option 3
131+
********
132+
133+
Send the patch, after verifying that it follows the above rules, to
134+
[email protected]. You must note the upstream commit ID in the
135+
changelog of your submission, as well as the kernel version you wish
136+
it to be applied to.
137+
138+
Note that for :ref:`option_3`, if the patch deviates from the original
139+
upstream patch (for example because it had to be backported) this must be very
140+
clearly documented and justified in the patch description.
141+
142+
The upstream commit ID must be specified with a separate line above the commit
143+
text, like this:
144+
145+
.. code-block:: none
146+
147+
commit <sha1> upstream.
148+
149+
or alternatively:
150+
151+
.. code-block:: none
152+
153+
[ Upstream commit <sha1> ]
154+
155155
Following the submission
156156
------------------------
157157

0 commit comments

Comments
 (0)