x86/Documentation: Add PTI description
[pandora-kernel.git] / Documentation / stable_kernel_rules.txt
1 Everything you ever wanted to know about Linux -stable releases.
2
3 Rules on what kind of patches are accepted, and which ones are not, into the
4 "-stable" tree:
5
6  - It must be obviously correct and tested.
7  - It cannot be bigger than 100 lines, with context.
8  - It must fix only one thing.
9  - It must fix a real bug that bothers people (not a, "This could be a
10    problem..." type thing).
11  - 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
13    security issue, or some "oh, that's not good" issue.  In short, something
14    critical.
15  - 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.
21  - New device IDs and quirks are also accepted.
22  - No "theoretical race condition" issues, unless an explanation of how the
23    race can be exploited is also provided.
24  - It cannot contain any "trivial" fixes in it (spelling changes,
25    whitespace cleanups, etc).
26  - It must follow the Documentation/SubmittingPatches rules.
27  - It or an equivalent fix must already exist in Linus' tree (upstream).
28
29
30 Procedure for submitting patches to the -stable tree:
31
32  - 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
35  - Send the patch, after verifying that it follows the above rules, to
36    stable@vger.kernel.org.  You must note the upstream commit ID in the
37    changelog of your submission.
38  - To have the patch automatically included in the stable tree, add the tag
39      Cc: stable@vger.kernel.org
40    in the sign-off area. Once the patch is merged it will be applied to
41    the stable tree without anything else needing to be done by the author
42    or subsystem maintainer.
43  - If the patch requires other patches as prerequisites which can be
44    cherry-picked than this can be specified in the following format in
45    the sign-off area:
46
47      Cc: <stable@vger.kernel.org> # 3.3.x: a1f84a3: sched: Check for idle
48      Cc: <stable@vger.kernel.org> # 3.3.x: 1b9508f: sched: Rate-limit newidle
49      Cc: <stable@vger.kernel.org> # 3.3.x: fd21073: sched: Fix affinity logic
50      Cc: <stable@vger.kernel.org> # 3.3.x
51     Signed-off-by: Ingo Molnar <mingo@elte.hu>
52
53    The tag sequence has the meaning of:
54      git cherry-pick a1f84a3
55      git cherry-pick 1b9508f
56      git cherry-pick fd21073
57      git cherry-pick <this commit>
58
59  - The sender will receive an ACK when the patch has been accepted into the
60    queue, or a NAK if the patch is rejected.  This response might take a few
61    days, according to the developer's schedules.
62  - If accepted, the patch will be added to the -stable queue, for review by
63    other developers and by the relevant subsystem maintainer.
64  - Security patches should not be sent to this alias, but instead to the
65    documented security@kernel.org address.
66
67
68 Review cycle:
69
70  - When the -stable maintainers decide for a review cycle, the patches will be
71    sent to the review committee, and the maintainer of the affected area of
72    the patch (unless the submitter is the maintainer of the area) and CC: to
73    the linux-kernel mailing list.
74  - The review committee has 48 hours in which to ACK or NAK the patch.
75  - If the patch is rejected by a member of the committee, or linux-kernel
76    members object to the patch, bringing up issues that the maintainers and
77    members did not realize, the patch will be dropped from the queue.
78  - At the end of the review cycle, the ACKed patches will be added to the
79    latest -stable release, and a new -stable release will happen.
80  - Security patches will be accepted into the -stable tree directly from the
81    security kernel team, and not go through the normal review cycle.
82    Contact the kernel security team for more details on this procedure.
83
84 Trees:
85
86  - The queues of patches, for both completed versions and in progress
87    versions can be found at:
88         http://git.kernel.org/?p=linux/kernel/git/stable/stable-queue.git
89  - The finalized and tagged releases of all stable kernels can be found
90    in separate branches per version at:
91         http://git.kernel.org/?p=linux/kernel/git/stable/linux-stable.git
92
93
94 Review committee:
95
96  - This is made up of a number of kernel developers who have volunteered for
97    this task, and a few that haven't.