Commit 5db34f5b authored by Thorsten Leemhuis's avatar Thorsten Leemhuis Committed by Jonathan Corbet

docs: stable-kernel-rules: remove code-labels tags and a indention level

Remove the 'code-block:: none' labels and switch to the shorter '::' to
reduce noise.

Remove a unneeded level of indentation, as that reduces the chance that
readers have to scroll sideways in some of the code blocks.

No text changes. Rendered html output looks like before, except for the
different level of indentation.

CC: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarThorsten Leemhuis <linux@leemhuis.info>
Reviewed-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/755afbeafc8e1457154cb4b30ff4397f34326679.1714367921.git.linux@leemhuis.info
parent 2263c40e
...@@ -6,13 +6,13 @@ Everything you ever wanted to know about Linux -stable releases ...@@ -6,13 +6,13 @@ Everything you ever wanted to know about Linux -stable releases
Rules on what kind of patches are accepted, and which ones are not, into the Rules on what kind of patches are accepted, and which ones are not, into the
"-stable" tree: "-stable" tree:
- It or an equivalent fix must already exist in Linux mainline (upstream). - It or an equivalent fix must already exist in Linux mainline (upstream).
- It must be obviously correct and tested. - It must be obviously correct and tested.
- It cannot be bigger than 100 lines, with context. - It cannot be bigger than 100 lines, with context.
- It must follow the - It must follow the
:ref:`Documentation/process/submitting-patches.rst <submittingpatches>` :ref:`Documentation/process/submitting-patches.rst <submittingpatches>`
rules. rules.
- It must either fix a real bug that bothers people or just add a device ID. - It must either fix a real bug that bothers people or just add a device ID.
To elaborate on the former: To elaborate on the former:
- It fixes a problem like an oops, a hang, data corruption, a real security - It fixes a problem like an oops, a hang, data corruption, a real security
...@@ -42,10 +42,10 @@ Procedure for submitting patches to the -stable tree ...@@ -42,10 +42,10 @@ 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:
1. Add a 'stable tag' to the description of a patch you then submit for 1. Add a 'stable tag' to the description of a patch you then submit for
mainline inclusion. mainline inclusion.
2. Ask the stable team to pick up a patch already mainlined. 2. Ask the stable team to pick up a patch already mainlined.
3. Submit a patch to the stable team that is equivalent to a change already 3. Submit a patch to the stable team that is equivalent to a change already
mainlined. mainlined.
The sections below describe each of the options in more detail. The sections below describe each of the options in more detail.
...@@ -68,22 +68,17 @@ Option 1 ...@@ -68,22 +68,17 @@ Option 1
******** ********
To have a patch you submit for mainline inclusion later automatically picked up To have a patch you submit for mainline inclusion later automatically picked up
for stable trees, add the tag for stable trees, add this tag in the sign-off area::
.. code-block:: none
Cc: stable@vger.kernel.org Cc: stable@vger.kernel.org
in the sign-off area. Once the patch is mainlined it will be applied to the Once the patch is mainlined it will be applied to the stable tree without
stable tree without anything else needing to be done by the author or anything else needing to be done by the author or subsystem maintainer.
subsystem maintainer.
To sent additional instructions to the stable team, use a shell-style inline To sent additional instructions to the stable team, use a shell-style inline
comment to pass arbitrary or predefined notes: comment to pass arbitrary or predefined notes:
* Specify any additional patch prerequisites for cherry picking: * Specify any additional patch prerequisites for cherry picking::
.. code-block:: none
Cc: <stable@vger.kernel.org> # 3.3.x: a1f84a3: sched: Check for idle Cc: <stable@vger.kernel.org> # 3.3.x: a1f84a3: sched: Check for idle
Cc: <stable@vger.kernel.org> # 3.3.x: 1b9508f: sched: Rate-limit newidle Cc: <stable@vger.kernel.org> # 3.3.x: 1b9508f: sched: Rate-limit newidle
...@@ -91,9 +86,7 @@ comment to pass arbitrary or predefined notes: ...@@ -91,9 +86,7 @@ comment to pass arbitrary or predefined notes:
Cc: <stable@vger.kernel.org> # 3.3.x Cc: <stable@vger.kernel.org> # 3.3.x
Signed-off-by: Ingo Molnar <mingo@elte.hu> Signed-off-by: Ingo Molnar <mingo@elte.hu>
The tag sequence has the meaning of: The tag sequence has the meaning of::
.. code-block:: none
git cherry-pick a1f84a3 git cherry-pick a1f84a3
git cherry-pick 1b9508f git cherry-pick 1b9508f
...@@ -102,9 +95,7 @@ comment to pass arbitrary or predefined notes: ...@@ -102,9 +95,7 @@ comment to pass arbitrary or predefined notes:
Note that for a patch series, you do not have to list as prerequisites the Note that for a patch series, you do not have to list as prerequisites the
patches present in the series itself. For example, if you have the following patches present in the series itself. For example, if you have the following
patch series: patch series::
.. code-block:: none
patch1 patch1
patch2 patch2
...@@ -113,15 +104,11 @@ comment to pass arbitrary or predefined notes: ...@@ -113,15 +104,11 @@ comment to pass arbitrary or predefined notes:
prerequisite of patch2 if you have already marked patch1 for stable prerequisite of patch2 if you have already marked patch1 for stable
inclusion. inclusion.
* Point out kernel version prerequisites: * Point out kernel version prerequisites::
.. code-block:: none
Cc: <stable@vger.kernel.org> # 3.3.x Cc: <stable@vger.kernel.org> # 3.3.x
The tag has the meaning of: The tag has the meaning of::
.. code-block:: none
git cherry-pick <this commit> git cherry-pick <this commit>
...@@ -130,15 +117,11 @@ comment to pass arbitrary or predefined notes: ...@@ -130,15 +117,11 @@ comment to pass arbitrary or predefined notes:
Note, such tagging is unnecessary if the stable team can derive the Note, such tagging is unnecessary if the stable team can derive the
appropriate versions from Fixes: tags. appropriate versions from Fixes: tags.
* Delay pick up of patches: * Delay pick up of patches::
.. code-block:: none
Cc: <stable@vger.kernel.org> # after -rc3 Cc: <stable@vger.kernel.org> # after -rc3
* Point out known problems: * Point out known problems::
.. 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
...@@ -160,15 +143,11 @@ Option 3 ...@@ -160,15 +143,11 @@ 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 and mention the kernel versions you wish it to be applied stable@vger.kernel.org and mention the kernel versions you wish it to be applied
to. When doing so, you must note the upstream commit ID in the changelog of your to. When doing so, you must note the upstream commit ID in the changelog of your
submission with a separate line above the commit text, like this: submission with a separate line above the commit text, like this::
.. code-block:: none
commit <sha1> upstream. commit <sha1> upstream.
or alternatively: Or alternatively::
.. code-block:: none
[ Upstream commit <sha1> ] [ Upstream commit <sha1> ]
...@@ -191,26 +170,26 @@ developers and by the relevant subsystem maintainer. ...@@ -191,26 +170,26 @@ developers and by the relevant subsystem maintainer.
Review cycle Review cycle
------------ ------------
- When the -stable maintainers decide for a review cycle, the patches will be - When the -stable maintainers decide for a review cycle, the patches will be
sent to the review committee, and the maintainer of the affected area of sent to the review committee, and the maintainer of the affected area of
the patch (unless the submitter is the maintainer of the area) and CC: to the patch (unless the submitter is the maintainer of the area) and CC: to
the linux-kernel mailing list. the linux-kernel mailing list.
- The review committee has 48 hours in which to ACK or NAK the patch. - The review committee has 48 hours in which to ACK or NAK the patch.
- If the patch is rejected by a member of the committee, or linux-kernel - If the patch is rejected by a member of the committee, or linux-kernel
members object to the patch, bringing up issues that the maintainers and members object to the patch, bringing up issues that the maintainers and
members did not realize, the patch will be dropped from the queue. members did not realize, the patch will be dropped from the queue.
- The ACKed patches will be posted again as part of release candidate (-rc) - The ACKed patches will be posted again as part of release candidate (-rc)
to be tested by developers and testers. to be tested by developers and testers.
- Usually only one -rc release is made, however if there are any outstanding - Usually only one -rc release is made, however if there are any outstanding
issues, some patches may be modified or dropped or additional patches may issues, some patches may be modified or dropped or additional patches may
be queued. Additional -rc releases are then released and tested until no be queued. Additional -rc releases are then released and tested until no
issues are found. issues are found.
- Responding to the -rc releases can be done on the mailing list by sending - Responding to the -rc releases can be done on the mailing list by sending
a "Tested-by:" email with any testing information desired. The "Tested-by:" a "Tested-by:" email with any testing information desired. The "Tested-by:"
tags will be collected and added to the release commit. tags will be collected and added to the release commit.
- At the end of the review cycle, the new -stable release will be released - At the end of the review cycle, the new -stable release will be released
containing all the queued and tested patches. containing all the queued and tested patches.
- Security patches will be accepted into the -stable tree directly from the - Security patches will be accepted into the -stable tree directly from the
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.
...@@ -218,17 +197,17 @@ Review cycle ...@@ -218,17 +197,17 @@ Review cycle
Trees Trees
----- -----
- The queues of patches, for both completed versions and in progress - The queues of patches, for both completed versions and in progress
versions can be found at: versions can be found at:
https://git.kernel.org/pub/scm/linux/kernel/git/stable/stable-queue.git https://git.kernel.org/pub/scm/linux/kernel/git/stable/stable-queue.git
- The finalized and tagged releases of all stable kernels can be found - The finalized and tagged releases of all stable kernels can be found
in separate branches per version at: in separate branches per version at:
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
- The release candidate of all stable kernel versions can be found at: - The release candidate of all stable kernel versions can be found at:
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable-rc.git/ https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable-rc.git/
...@@ -241,5 +220,5 @@ Trees ...@@ -241,5 +220,5 @@ Trees
Review committee Review committee
---------------- ----------------
- This is made up of a number of kernel developers who have volunteered for - This is made up of a number of kernel developers who have volunteered for
this task, and a few that haven't. this task, and a few that haven't.
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