Skip to content

Commit

Permalink
docs: stable-kernel-rules: make the examples for option 1 a proper list
Browse files Browse the repository at this point in the history
Separate the description for option 1 and the examples how to use it by
making the latter an indented unordered list.

No text changes.

CC: Greg KH <gregkh@linuxfoundation.org>
CC: Sasha Levin <sashal@kernel.org>
CC: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
Link: https://lore.kernel.org/r/59deaabfabf0629d7cf2a52b196cec19d1f9ec47.1691219455.git.linux@leemhuis.info
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
  • Loading branch information
Thorsten Leemhuis authored and Greg Kroah-Hartman committed Aug 12, 2023
1 parent 3feb21b commit 189057a
Showing 1 changed file with 25 additions and 23 deletions.
48 changes: 25 additions & 23 deletions Documentation/process/stable-kernel-rules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,59 +59,61 @@ To have the patch automatically included in the stable tree, add the tag
Cc: stable@vger.kernel.org
in the sign-off area. To accompany a note to the stable team, use a shell-style
inline comment (see below for details). Once the patch is merged it will be
applied to the stable tree without anything else needing to be done by the
author or subsystem maintainer.
in the sign-off area. Once the patch is merged it will be applied to the
stable tree without anything else needing to be done by the author or
subsystem maintainer.

Additionally, some patches submitted via :ref:`option_1` may have additional
patch prerequisites which can be cherry-picked. This can be specified in the
following format in the sign-off area:
To accompany a note to the stable team, use a shell-style inline comment (see
below for details):

.. code-block:: none
* Additionally, some patches submitted via :ref:`option_1` may have additional
patch prerequisites which can be cherry-picked. This can be specified in the
following format in the sign-off area:

.. code-block:: none
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: fd21073: sched: Fix affinity logic
Cc: <stable@vger.kernel.org> # 3.3.x
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
.. code-block:: none
git cherry-pick a1f84a3
git cherry-pick 1b9508f
git cherry-pick fd21073
git cherry-pick <this commit>
Also, some patches may have kernel version prerequisites. This can be
specified in the following format in the sign-off area:
* Also, some patches may have kernel version prerequisites. This can be
specified in the following format in the sign-off area:

.. code-block:: none
.. code-block:: none
Cc: <stable@vger.kernel.org> # 3.3.x
The tag has the meaning of:
The tag has the meaning of:

.. code-block:: none
.. code-block:: none
git cherry-pick <this commit>
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
format:
* To delay pick up of patches submitted via :ref:`option_1`, use the following
format:

.. code-block:: none
.. code-block:: none
Cc: <stable@vger.kernel.org> # after 4 weeks in mainline
For any other requests related to patches submitted via :ref:`option_1`, just
add a note to the stable tag. This for example can be used to point out known
problems:
* For any other requests related to patches submitted via :ref:`option_1`, just
add a note to the stable tag. This for example can be used to point out known
problems:

.. code-block:: none
.. code-block:: none
Cc: <stable@vger.kernel.org> # see patch description, needs adjustments for >= 6.3
Expand Down

0 comments on commit 189057a

Please sign in to comment.