Commit 6e160d29 authored by Thorsten Leemhuis's avatar Thorsten Leemhuis Committed by Greg Kroah-Hartman

docs: stable-kernel-rules: fine-tune various details

* various fine tuning to the text that cleans up rough edges the three
  previous preparatory patches left behind to keep the diffs simpler
* s/Linus' tree/mainline/g, as that's the term more commonly used and
  known
* create a short intro for the three submission options and streamline
  the explanation when to use which of them
* fix a >= vs <= thinko in an example to make it more straight forward
* there were two blank lines before some sub-headings and just one
  before others; use the former style everywhere

CC: Greg KH <gregkh@linuxfoundation.org>
CC: Sasha Levin <sashal@kernel.org>
CC: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarThorsten Leemhuis <linux@leemhuis.info>
Link: https://lore.kernel.org/r/e1960a70acae2c2f18b838aee9f8bf6055fae89b.1691219455.git.linux@leemhuis.infoSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 189057a1
...@@ -30,6 +30,7 @@ Rules on what kind of patches are accepted, and which ones are not, into the ...@@ -30,6 +30,7 @@ Rules on what kind of patches are accepted, and which ones are not, into the
- No "trivial" fixes without benefit for users (spelling changes, whitespace - No "trivial" fixes without benefit for users (spelling changes, whitespace
cleanups, etc). cleanups, etc).
Procedure for submitting patches to the -stable tree Procedure for submitting patches to the -stable tree
---------------------------------------------------- ----------------------------------------------------
...@@ -41,33 +42,40 @@ Procedure for submitting patches to the -stable tree ...@@ -41,33 +42,40 @@ Procedure for submitting patches to the -stable tree
There are three options to submit a change to -stable trees: There are three options to submit a change to -stable trees:
:ref:`option_1` is **strongly** preferred, is the easiest and most common. 1. Add a 'stable tag' to the description of a patch you then submit for
:ref:`option_2` and :ref:`option_3` are more useful if the patch isn't deemed mainline inclusion.
worthy at the time it is applied to a public git tree (for instance, because 2. Ask the stable team to pick up a patch already mainlined.
it deserves more regression testing first). :ref:`option_3` is especially 3. Submit a patch to the stable team that is equivalent to a change already
useful if the original upstream patch needs to be backported (for example mainlined.
the backport needs some special handling due to e.g. API changes).
The sections below describe each of the options in more detail.
:ref:`option_1` is **strongly** preferred, it is the easiest and most common.
:ref:`option_2` is mainly meant for changes where backporting was not considered
at the time of submission. :ref:`option_3` is an alternative to the two earlier
options for cases where a mainlined patch needs adjustments to apply in older
series (for example due to API changes).
.. _option_1: .. _option_1:
Option 1 Option 1
******** ********
To have the patch automatically included in the stable tree, add the tag To have a patch you submit for mainline inclusion later automatically picked up
for stable trees, add the tag
.. code-block:: none .. code-block:: none
Cc: stable@vger.kernel.org Cc: stable@vger.kernel.org
in the sign-off area. Once the patch is merged it will be applied to the in the sign-off area. Once the patch is mainlined it will be applied to the
stable tree without anything else needing to be done by the author or stable tree without anything else needing to be done by the author or
subsystem maintainer. subsystem maintainer.
To accompany a note to the stable team, use a shell-style inline comment (see To sent additional instructions to the stable team, use a shell-style inline
below for details): comment:
* Additionally, some patches submitted via :ref:`option_1` may have additional * To specify any additional patch prerequisites for cherry picking use the
patch prerequisites which can be cherry-picked. This can be specified in the
following format in the sign-off area: following format in the sign-off area:
.. code-block:: none .. code-block:: none
...@@ -87,8 +95,8 @@ below for details): ...@@ -87,8 +95,8 @@ below for details):
git cherry-pick fd21073 git cherry-pick fd21073
git cherry-pick <this commit> git cherry-pick <this commit>
* Also, some patches may have kernel version prerequisites. This can be * For patches that may have kernel version prerequisites specify them using
specified in the following format in the sign-off area: the following format in the sign-off area:
.. code-block:: none .. code-block:: none
...@@ -102,27 +110,28 @@ below for details): ...@@ -102,27 +110,28 @@ below for details):
For each "-stable" tree starting with the specified version. For each "-stable" tree starting with the specified version.
* To delay pick up of patches submitted via :ref:`option_1`, use the following Note, such tagging is unnecessary if the stable team can derive the
format: appropriate versions from Fixes: tags.
* To delay pick up of patches, use the following format:
.. code-block:: none .. code-block:: none
Cc: <stable@vger.kernel.org> # after 4 weeks in mainline Cc: <stable@vger.kernel.org> # after 4 weeks in mainline
* For any other requests related to patches submitted via :ref:`option_1`, just * For any other requests, just add a note to the stable tag. This for example
add a note to the stable tag. This for example can be used to point out known can be used to point out known problems:
problems:
.. code-block:: none .. code-block:: none
Cc: <stable@vger.kernel.org> # see patch description, needs adjustments for >= 6.3 Cc: <stable@vger.kernel.org> # see patch description, needs adjustments for <= 6.3
.. _option_2: .. _option_2:
Option 2 Option 2
******** ********
After the patch has been merged to Linus' tree, send an email to If the patch already has been merged to mainline, send an email to
stable@vger.kernel.org containing the subject of the patch, the commit ID, stable@vger.kernel.org containing the subject of the patch, the commit ID,
why you think it should be applied, and what kernel version you wish it to why you think it should be applied, and what kernel version you wish it to
be applied to. be applied to.
...@@ -133,16 +142,9 @@ Option 3 ...@@ -133,16 +142,9 @@ Option 3
******** ********
Send the patch, after verifying that it follows the above rules, to Send the patch, after verifying that it follows the above rules, to
stable@vger.kernel.org. You must note the upstream commit ID in the stable@vger.kernel.org and mention the kernel version you wish it to be applied
changelog of your submission, as well as the kernel version you wish to. When doing so, you must note the upstream commit ID in the changelog of your
it to be applied to. submission with a separate line above the commit text, like this:
Note that for :ref:`option_3`, if the patch deviates from the original
upstream patch (for example because it had to be backported) this must be very
clearly documented and justified in the patch description.
The upstream commit ID must be specified with a separate line above the commit
text, like this:
.. code-block:: none .. code-block:: none
...@@ -154,12 +156,17 @@ or alternatively: ...@@ -154,12 +156,17 @@ or alternatively:
[ Upstream commit <sha1> ] [ Upstream commit <sha1> ]
If the submitted patch deviates from the original upstream patch (for example
because it had to be adjusted for the older API), this must be very clearly
documented and justified in the patch description.
Following the submission Following the submission
------------------------ ------------------------
The sender will receive an ACK when the patch has been accepted into the The sender will receive an ACK when the patch has been accepted into the
queue, or a NAK if the patch is rejected. This response might take a few queue, or a NAK if the patch is rejected. This response might take a few
days, according to the developer's schedules. days, according to the schedules of the stable team members.
If accepted, the patch will be added to the -stable queue, for review by other If accepted, the patch will be added to the -stable queue, for review by other
developers and by the relevant subsystem maintainer. developers and by the relevant subsystem maintainer.
...@@ -191,6 +198,7 @@ Review cycle ...@@ -191,6 +198,7 @@ Review cycle
security kernel team, and not go through the normal review cycle. security kernel team, and not go through the normal review cycle.
Contact the kernel security team for more details on this procedure. Contact the kernel security team for more details on this procedure.
Trees Trees
----- -----
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment