Commit | Line | Data |
---|---|---|
609d99a3 MCC |
1 | .. _stable_kernel_rules: |
2 | ||
5fe270a4 MCC |
3 | Everything you ever wanted to know about Linux -stable releases |
4 | =============================================================== | |
fc185d95 | 5 | |
e48e9909 JJ |
6 | Rules on what kind of patches are accepted, and which ones are not, into the |
7 | "-stable" tree: | |
fc185d95 GK |
8 | |
9 | - It must be obviously correct and tested. | |
84eb8d06 | 10 | - It cannot be bigger than 100 lines, with context. |
fc185d95 GK |
11 | - It must fix only one thing. |
12 | - It must fix a real bug that bothers people (not a, "This could be a | |
e48e9909 | 13 | problem..." type thing). |
fc185d95 GK |
14 | - It must fix a problem that causes a build error (but not for things |
15 | marked CONFIG_BROKEN), an oops, a hang, data corruption, a real | |
e48e9909 JJ |
16 | security issue, or some "oh, that's not good" issue. In short, something |
17 | critical. | |
8191e0d9 MG |
18 | - Serious issues as reported by a user of a distribution kernel may also |
19 | be considered if they fix a notable performance or interactivity issue. | |
20 | As these fixes are not as obvious and have a higher risk of a subtle | |
21 | regression they should only be submitted by a distribution kernel | |
22 | maintainer and include an addendum linking to a bugzilla entry if it | |
23 | exists and additional information on the user-visible impact. | |
79cd80a1 | 24 | - New device IDs and quirks are also accepted. |
e48e9909 JJ |
25 | - No "theoretical race condition" issues, unless an explanation of how the |
26 | race can be exploited is also provided. | |
84eb8d06 | 27 | - It cannot contain any "trivial" fixes in it (spelling changes, |
e48e9909 | 28 | whitespace cleanups, etc). |
dca22a63 | 29 | - It must follow the |
8c27ceff | 30 | :ref:`Documentation/process/submitting-patches.rst <submittingpatches>` |
dca22a63 | 31 | rules. |
959fb1c5 | 32 | - It or an equivalent fix must already exist in Linus' tree (upstream). |
fc185d95 GK |
33 | |
34 | ||
5fe270a4 MCC |
35 | Procedure for submitting patches to the -stable tree |
36 | ---------------------------------------------------- | |
fc185d95 | 37 | |
5de61e7a | 38 | - Security patches should not be handled (solely) by the -stable review |
dca22a63 | 39 | process but should follow the procedures in |
8c27ceff | 40 | :ref:`Documentation/admin-guide/security-bugs.rst <securitybugs>`. |
5de61e7a | 41 | |
5fe270a4 MCC |
42 | For all other submissions, choose one of the following procedures |
43 | ----------------------------------------------------------------- | |
5de61e7a | 44 | |
5fe270a4 MCC |
45 | .. _option_1: |
46 | ||
47 | Option 1 | |
48 | ******** | |
49 | ||
50 | To have the patch automatically included in the stable tree, add the tag | |
51 | ||
52 | .. code-block:: none | |
5de61e7a | 53 | |
5fa22429 | 54 | Cc: stable@vger.kernel.org |
5de61e7a | 55 | |
5fe270a4 MCC |
56 | in the sign-off area. Once the patch is merged it will be applied to |
57 | the stable tree without anything else needing to be done by the author | |
58 | or subsystem maintainer. | |
59 | ||
60 | .. _option_2: | |
5de61e7a | 61 | |
5fe270a4 MCC |
62 | Option 2 |
63 | ******** | |
5de61e7a | 64 | |
5fe270a4 MCC |
65 | After the patch has been merged to Linus' tree, send an email to |
66 | stable@vger.kernel.org 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. | |
5de61e7a | 69 | |
5fe270a4 | 70 | .. _option_3: |
5de61e7a | 71 | |
5fe270a4 MCC |
72 | Option 3 |
73 | ******** | |
bde1b294 | 74 | |
5fe270a4 MCC |
75 | Send the patch, after verifying that it follows the above rules, to |
76 | stable@vger.kernel.org. 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 patch needs some special handling to apply to an older kernel | |
85 | (e.g., if API's have changed in the meantime). | |
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. | |
bde1b294 CD |
90 | |
91 | The upstream commit ID must be specified with a separate line above the commit | |
92 | text, like this: | |
93 | ||
5fe270a4 MCC |
94 | .. code-block:: none |
95 | ||
bde1b294 | 96 | commit <sha1> upstream. |
5de61e7a | 97 | |
b04c11c9 FV |
98 | Additionally, some patches submitted via :ref:`option_1` may have additional |
99 | patch prerequisites which can be cherry-picked. This can be specified in the | |
100 | following format in the sign-off area: | |
8e9b9362 | 101 | |
5fe270a4 MCC |
102 | .. code-block:: none |
103 | ||
2584f521 PG |
104 | Cc: <stable@vger.kernel.org> # 3.3.x: a1f84a3: sched: Check for idle |
105 | Cc: <stable@vger.kernel.org> # 3.3.x: 1b9508f: sched: Rate-limit newidle | |
106 | Cc: <stable@vger.kernel.org> # 3.3.x: fd21073: sched: Fix affinity logic | |
107 | Cc: <stable@vger.kernel.org> # 3.3.x | |
5fe270a4 MCC |
108 | Signed-off-by: Ingo Molnar <mingo@elte.hu> |
109 | ||
110 | The tag sequence has the meaning of: | |
111 | ||
112 | .. code-block:: none | |
8e9b9362 | 113 | |
8e9b9362 SAS |
114 | git cherry-pick a1f84a3 |
115 | git cherry-pick 1b9508f | |
116 | git cherry-pick fd21073 | |
117 | git cherry-pick <this commit> | |
118 | ||
fdc81b79 DD |
119 | Also, some patches may have kernel version prerequisites. This can be |
120 | specified in the following format in the sign-off area: | |
121 | ||
5fe270a4 MCC |
122 | .. code-block:: none |
123 | ||
cf903e9d | 124 | Cc: <stable@vger.kernel.org> # 3.3.x |
fdc81b79 | 125 | |
5fe270a4 MCC |
126 | The tag has the meaning of: |
127 | ||
128 | .. code-block:: none | |
129 | ||
fdc81b79 DD |
130 | git cherry-pick <this commit> |
131 | ||
5fe270a4 | 132 | For each "-stable" tree starting with the specified version. |
fdc81b79 | 133 | |
5de61e7a BN |
134 | Following the submission: |
135 | ||
e48e9909 JJ |
136 | - The sender will receive an ACK when the patch has been accepted into the |
137 | queue, or a NAK if the patch is rejected. This response might take a few | |
138 | days, according to the developer's schedules. | |
139 | - If accepted, the patch will be added to the -stable queue, for review by | |
46cdf871 | 140 | other developers and by the relevant subsystem maintainer. |
fc185d95 GK |
141 | |
142 | ||
5fe270a4 MCC |
143 | Review cycle |
144 | ------------ | |
fc185d95 | 145 | |
e48e9909 JJ |
146 | - When the -stable maintainers decide for a review cycle, the patches will be |
147 | sent to the review committee, and the maintainer of the affected area of | |
148 | the patch (unless the submitter is the maintainer of the area) and CC: to | |
149 | the linux-kernel mailing list. | |
150 | - The review committee has 48 hours in which to ACK or NAK the patch. | |
fc185d95 | 151 | - If the patch is rejected by a member of the committee, or linux-kernel |
e48e9909 JJ |
152 | members object to the patch, bringing up issues that the maintainers and |
153 | members did not realize, the patch will be dropped from the queue. | |
154 | - At the end of the review cycle, the ACKed patches will be added to the | |
155 | latest -stable release, and a new -stable release will happen. | |
156 | - Security patches will be accepted into the -stable tree directly from the | |
157 | security kernel team, and not go through the normal review cycle. | |
fc185d95 GK |
158 | Contact the kernel security team for more details on this procedure. |
159 | ||
5fe270a4 MCC |
160 | Trees |
161 | ----- | |
2584f521 PG |
162 | |
163 | - The queues of patches, for both completed versions and in progress | |
164 | versions can be found at: | |
5fe270a4 | 165 | |
c1aa3871 | 166 | https://git.kernel.org/pub/scm/linux/kernel/git/stable/stable-queue.git |
5fe270a4 | 167 | |
2584f521 PG |
168 | - The finalized and tagged releases of all stable kernels can be found |
169 | in separate branches per version at: | |
5fe270a4 | 170 | |
c1aa3871 | 171 | https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git |
2584f521 | 172 | |
fc185d95 | 173 | |
5fe270a4 MCC |
174 | Review committee |
175 | ---------------- | |
fc185d95 | 176 | |
e48e9909 JJ |
177 | - This is made up of a number of kernel developers who have volunteered for |
178 | this task, and a few that haven't. |