blob: 58d0ac4df94684d540f5afea73d4039726e6a4be [file] [log] [blame]
Paul Gortmaker2584f522012-06-05 11:15:50 -04001Everything you ever wanted to know about Linux -stable releases.
Greg KHfc185d92005-07-29 12:14:34 -07002
Jesper Juhle48e9902006-01-09 20:53:59 -08003Rules on what kind of patches are accepted, and which ones are not, into the
4"-stable" tree:
Greg KHfc185d92005-07-29 12:14:34 -07005
6 - It must be obviously correct and tested.
Matt LaPlante84eb8d02006-10-03 22:53:09 +02007 - It cannot be bigger than 100 lines, with context.
Greg KHfc185d92005-07-29 12:14:34 -07008 - It must fix only one thing.
9 - It must fix a real bug that bothers people (not a, "This could be a
Jesper Juhle48e9902006-01-09 20:53:59 -080010 problem..." type thing).
Greg KHfc185d92005-07-29 12:14:34 -070011 - It must fix a problem that causes a build error (but not for things
12 marked CONFIG_BROKEN), an oops, a hang, data corruption, a real
Jesper Juhle48e9902006-01-09 20:53:59 -080013 security issue, or some "oh, that's not good" issue. In short, something
14 critical.
Mel Gorman8191e0d2012-06-21 11:36:50 +010015 - Serious issues as reported by a user of a distribution kernel may also
16 be considered if they fix a notable performance or interactivity issue.
17 As these fixes are not as obvious and have a higher risk of a subtle
18 regression they should only be submitted by a distribution kernel
19 maintainer and include an addendum linking to a bugzilla entry if it
20 exists and additional information on the user-visible impact.
Josh Boyer79cd80a2008-10-24 10:10:42 -040021 - New device IDs and quirks are also accepted.
Jesper Juhle48e9902006-01-09 20:53:59 -080022 - No "theoretical race condition" issues, unless an explanation of how the
23 race can be exploited is also provided.
Matt LaPlante84eb8d02006-10-03 22:53:09 +020024 - It cannot contain any "trivial" fixes in it (spelling changes,
Jesper Juhle48e9902006-01-09 20:53:59 -080025 whitespace cleanups, etc).
Jesper Juhle48e9902006-01-09 20:53:59 -080026 - It must follow the Documentation/SubmittingPatches rules.
Stefan Richter959fb1c2010-04-01 22:01:52 +020027 - It or an equivalent fix must already exist in Linus' tree (upstream).
Greg KHfc185d92005-07-29 12:14:34 -070028
29
30Procedure for submitting patches to the -stable tree:
31
Dave Chilukb76fc282014-06-24 10:11:26 -050032 - If the patch covers files in net/ or drivers/net please follow netdev stable
33 submission guidelines as described in
34 Documentation/networking/netdev-FAQ.txt
Brian Norris5de61e72014-12-18 14:55:53 -080035 - Security patches should not be handled (solely) by the -stable review
36 process but should follow the procedures in Documentation/SecurityBugs.
37
38For all other submissions, choose one of the following procedures:
39
40 --- Option 1 ---
41
42 To have the patch automatically included in the stable tree, add the tag
Josh Boyer5fa22422011-10-17 21:16:39 -040043 Cc: stable@vger.kernel.org
Sebastian Andrzej Siewior8e9b9362009-12-06 12:24:31 +010044 in the sign-off area. Once the patch is merged it will be applied to
45 the stable tree without anything else needing to be done by the author
46 or subsystem maintainer.
Brian Norris5de61e72014-12-18 14:55:53 -080047
48 --- Option 2 ---
49
50 After the patch has been merged to Linus' tree, send an email to
51 stable@vger.kernel.org containing the subject of the patch, the commit ID,
52 why you think it should be applied, and what kernel version you wish it to
53 be applied to.
54
55 --- Option 3 ---
56
57 Send the patch, after verifying that it follows the above rules, to
58 stable@vger.kernel.org. You must note the upstream commit ID in the
59 changelog of your submission, as well as the kernel version you wish
60 it to be applied to.
61
62Option 1 is probably the easiest and most common. Options 2 and 3 are more
63useful if the patch isn't deemed worthy at the time it is applied to a public
64git tree (for instance, because it deserves more regression testing first).
65Option 3 is especially useful if the patch needs some special handling to apply
66to an older kernel (e.g., if API's have changed in the meantime).
67
68Additionally, some patches submitted via Option 1 may have additional patch
69prerequisites which can be cherry-picked. This can be specified in the following
70format in the sign-off area:
Sebastian Andrzej Siewior8e9b9362009-12-06 12:24:31 +010071
Paul Gortmaker2584f522012-06-05 11:15:50 -040072 Cc: <stable@vger.kernel.org> # 3.3.x: a1f84a3: sched: Check for idle
73 Cc: <stable@vger.kernel.org> # 3.3.x: 1b9508f: sched: Rate-limit newidle
74 Cc: <stable@vger.kernel.org> # 3.3.x: fd21073: sched: Fix affinity logic
75 Cc: <stable@vger.kernel.org> # 3.3.x
Sebastian Andrzej Siewior8e9b9362009-12-06 12:24:31 +010076 Signed-off-by: Ingo Molnar <mingo@elte.hu>
77
78 The tag sequence has the meaning of:
79 git cherry-pick a1f84a3
80 git cherry-pick 1b9508f
81 git cherry-pick fd21073
82 git cherry-pick <this commit>
83
David Daneyfdc81b72015-03-26 10:09:08 -070084Also, some patches may have kernel version prerequisites. This can be
85specified in the following format in the sign-off area:
86
87 Cc: <stable@vger.kernel.org> # 3.3.x-
88
89 The tag has the meaning of:
90 git cherry-pick <this commit>
91
92 For each "-stable" tree starting with the specified version.
93
Brian Norris5de61e72014-12-18 14:55:53 -080094Following the submission:
95
Jesper Juhle48e9902006-01-09 20:53:59 -080096 - The sender will receive an ACK when the patch has been accepted into the
97 queue, or a NAK if the patch is rejected. This response might take a few
98 days, according to the developer's schedules.
99 - If accepted, the patch will be added to the -stable queue, for review by
Stefan Richter46cdf8712008-02-08 23:26:02 +0100100 other developers and by the relevant subsystem maintainer.
Greg KHfc185d92005-07-29 12:14:34 -0700101
102
103Review cycle:
104
Jesper Juhle48e9902006-01-09 20:53:59 -0800105 - When the -stable maintainers decide for a review cycle, the patches will be
106 sent to the review committee, and the maintainer of the affected area of
107 the patch (unless the submitter is the maintainer of the area) and CC: to
108 the linux-kernel mailing list.
109 - The review committee has 48 hours in which to ACK or NAK the patch.
Greg KHfc185d92005-07-29 12:14:34 -0700110 - If the patch is rejected by a member of the committee, or linux-kernel
Jesper Juhle48e9902006-01-09 20:53:59 -0800111 members object to the patch, bringing up issues that the maintainers and
112 members did not realize, the patch will be dropped from the queue.
113 - At the end of the review cycle, the ACKed patches will be added to the
114 latest -stable release, and a new -stable release will happen.
115 - Security patches will be accepted into the -stable tree directly from the
116 security kernel team, and not go through the normal review cycle.
Greg KHfc185d92005-07-29 12:14:34 -0700117 Contact the kernel security team for more details on this procedure.
118
Paul Gortmaker2584f522012-06-05 11:15:50 -0400119Trees:
120
121 - The queues of patches, for both completed versions and in progress
122 versions can be found at:
123 http://git.kernel.org/?p=linux/kernel/git/stable/stable-queue.git
124 - The finalized and tagged releases of all stable kernels can be found
125 in separate branches per version at:
126 http://git.kernel.org/?p=linux/kernel/git/stable/linux-stable.git
127
Greg KHfc185d92005-07-29 12:14:34 -0700128
Matt LaPlante5d3f0832006-11-30 05:21:10 +0100129Review committee:
Greg KHfc185d92005-07-29 12:14:34 -0700130
Jesper Juhle48e9902006-01-09 20:53:59 -0800131 - This is made up of a number of kernel developers who have volunteered for
132 this task, and a few that haven't.