@@ -30,6 +30,7 @@ Rules on what kind of patches are accepted, and which ones are not, into the
3030 - No "trivial" fixes without benefit for users (spelling changes, whitespace
3131 cleanups, etc).
3232
33+
3334Procedure for submitting patches to the -stable tree
3435----------------------------------------------------
3536
@@ -41,33 +42,40 @@ Procedure for submitting patches to the -stable tree
4142
4243There are three options to submit a change to -stable trees:
4344
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).
45+ 1. Add a 'stable tag' to the description of a patch you then submit for
46+ mainline inclusion.
47+ 2. Ask the stable team to pick up a patch already mainlined.
48+ 3. Submit a patch to the stable team that is equivalent to a change already
49+ mainlined.
50+
51+ The sections below describe each of the options in more detail.
52+
53+ :ref: `option_1 ` is **strongly ** preferred, it is the easiest and most common.
54+ :ref: `option_2 ` is mainly meant for changes where backporting was not considered
55+ at the time of submission. :ref: `option_3 ` is an alternative to the two earlier
56+ options for cases where a mainlined patch needs adjustments to apply in older
57+ series (for example due to API changes).
5058
5159.. _option_1 :
5260
5361Option 1
5462********
5563
56- To have the patch automatically included in the stable tree, add the tag
64+ To have a patch you submit for mainline inclusion later automatically picked up
65+ for stable trees, add the tag
5766
5867.. code-block :: none
5968
6069 Cc: stable@vger.kernel.org
6170
62- in the sign-off area. Once the patch is merged it will be applied to the
71+ in the sign-off area. Once the patch is mainlined it will be applied to the
6372stable tree without anything else needing to be done by the author or
6473subsystem maintainer.
6574
66- To accompany a note to the stable team, use a shell-style inline comment (see
67- below for details) :
75+ To sent additional instructions to the stable team, use a shell-style inline
76+ comment :
6877
69- * Additionally, some patches submitted via :ref: `option_1 ` may have additional
70- patch prerequisites which can be cherry-picked. This can be specified in the
78+ * To specify any additional patch prerequisites for cherry picking use the
7179 following format in the sign-off area:
7280
7381 .. code-block :: none
@@ -87,8 +95,8 @@ below for details):
8795 git cherry-pick fd21073
8896 git cherry-pick <this commit>
8997
90- * Also, some patches may have kernel version prerequisites. This can be
91- specified in the following format in the sign-off area:
98+ * For patches that may have kernel version prerequisites specify them using
99+ the following format in the sign-off area:
92100
93101 .. code-block :: none
94102
@@ -102,27 +110,28 @@ below for details):
102110
103111 For each "-stable" tree starting with the specified version.
104112
105- * To delay pick up of patches submitted via :ref: `option_1 `, use the following
106- format:
113+ Note, such tagging is unnecessary if the stable team can derive the
114+ appropriate versions from Fixes: tags.
115+
116+ * To delay pick up of patches, use the following format:
107117
108118 .. code-block :: none
109119
110120 Cc: <stable@vger.kernel.org> # after 4 weeks in mainline
111121
112- * For any other requests related to patches submitted via :ref: `option_1 `, just
113- add a note to the stable tag. This for example can be used to point out known
114- problems:
122+ * For any other requests, just add a note to the stable tag. This for example
123+ can be used to point out known problems:
115124
116125 .. code-block :: none
117126
118- Cc: <stable@vger.kernel.org> # see patch description, needs adjustments for > = 6.3
127+ Cc: <stable@vger.kernel.org> # see patch description, needs adjustments for < = 6.3
119128
120129 .. _option_2 :
121130
122131Option 2
123132********
124133
125- After the patch has been merged to Linus' tree , send an email to
134+ If the patch already has been merged to mainline , send an email to
126135stable@vger.kernel.org containing the subject of the patch, the commit ID,
127136why you think it should be applied, and what kernel version you wish it to
128137be applied to.
@@ -133,16 +142,9 @@ Option 3
133142********
134143
135144Send the patch, after verifying that it follows the above rules, to
136- stable@vger.kernel.org. You must note the upstream commit ID in the
137- changelog of your submission, as well as the kernel version you wish
138- it to be applied to.
139-
140- Note that for :ref: `option_3 `, if the patch deviates from the original
141- upstream patch (for example because it had to be backported) this must be very
142- clearly documented and justified in the patch description.
143-
144- The upstream commit ID must be specified with a separate line above the commit
145- text, like this:
145+ stable@vger.kernel.org and mention the kernel version you wish it to be applied
146+ to. When doing so, you must note the upstream commit ID in the changelog of your
147+ submission with a separate line above the commit text, like this:
146148
147149.. code-block :: none
148150
@@ -154,12 +156,17 @@ or alternatively:
154156
155157 [ Upstream commit <sha1> ]
156158
159+ If the submitted patch deviates from the original upstream patch (for example
160+ because it had to be adjusted for the older API), this must be very clearly
161+ documented and justified in the patch description.
162+
163+
157164Following the submission
158165------------------------
159166
160167The sender will receive an ACK when the patch has been accepted into the
161168queue, or a NAK if the patch is rejected. This response might take a few
162- days, according to the developer's schedules.
169+ days, according to the schedules of the stable team members .
163170
164171If accepted, the patch will be added to the -stable queue, for review by other
165172developers and by the relevant subsystem maintainer.
@@ -191,6 +198,7 @@ Review cycle
191198 security kernel team, and not go through the normal review cycle.
192199 Contact the kernel security team for more details on this procedure.
193200
201+
194202Trees
195203-----
196204
0 commit comments