2024-04-11 05:25:35

by Thorsten Leemhuis

[permalink] [raw]
Subject: [PATCH v1 4/4] docs: stable-kernel-rules: remove code-labels tags

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

CC: Jonathan Corbet <[email protected]>
Signed-off-by: Thorsten Leemhuis <[email protected]>
---
Intentionally the last patch in the series to make it easy to skip in
case Jonathan or someone else points out there is a reason for these
tags.
---
Documentation/process/stable-kernel-rules.rst | 37 +++++--------------
1 file changed, 10 insertions(+), 27 deletions(-)

diff --git a/Documentation/process/stable-kernel-rules.rst b/Documentation/process/stable-kernel-rules.rst
index 3c05f39858c78a..0ae38472bb688c 100644
--- a/Documentation/process/stable-kernel-rules.rst
+++ b/Documentation/process/stable-kernel-rules.rst
@@ -68,22 +68,17 @@ Option 1
********

To have a patch you submit for mainline inclusion later automatically picked up
-for stable trees, add the tag
-
-.. code-block:: none
+for stable trees, add this tag in the sign-off area::

Cc: [email protected]

-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
-subsystem maintainer.
+Once the patch is mainlined it will be applied to the stable tree without
+anything else needing to be done by the author or subsystem maintainer.

To sent additional instructions to the stable team, use a shell-style inline
comment to pass arbitrary or predefined notes:

- * Specify any additional patch prerequisites for cherry picking:
-
- .. code-block:: none
+ * Specify any additional patch prerequisites for cherry picking::

Cc: <[email protected]> # 3.3.x: a1f84a3: sched: Check for idle
Cc: <[email protected]> # 3.3.x: 1b9508f: sched: Rate-limit newidle
@@ -91,24 +86,18 @@ comment to pass arbitrary or predefined notes:
Cc: <[email protected]> # 3.3.x
Signed-off-by: Ingo Molnar <[email protected]>

- The tag sequence has the meaning of:
-
- .. code-block:: none
+ The tag sequence has the meaning of::

git cherry-pick a1f84a3
git cherry-pick 1b9508f
git cherry-pick fd21073
git cherry-pick <this commit>

- * Point out kernel version prerequisites:
-
- .. code-block:: none
+ * Point out kernel version prerequisites::

Cc: <[email protected]> # 3.3.x

- The tag has the meaning of:
-
- .. code-block:: none
+ The tag has the meaning of::

git cherry-pick <this commit>

@@ -129,9 +118,7 @@ comment to pass arbitrary or predefined notes:

Cc: <[email protected]> # after 6 weeks in a stable mainline release

- * Point out known problems:
-
- .. code-block:: none
+ * Point out known problems::

Cc: <[email protected]> # see patch description, needs adjustments for <= 6.3

@@ -153,15 +140,11 @@ Option 3
Send the patch, after verifying that it follows the above rules, to
[email protected] 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
-submission with a separate line above the commit text, like this:
-
-.. code-block:: none
+submission with a separate line above the commit text, like this::

commit <sha1> upstream.

-or alternatively:
-
-.. code-block:: none
+Or alternatively::

[ Upstream commit <sha1> ]

--
2.44.0



2024-04-11 05:41:29

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH v1 4/4] docs: stable-kernel-rules: remove code-labels tags

On Thu, Apr 11, 2024 at 07:25:06AM +0200, Thorsten Leemhuis wrote:
> Remove the 'code-block:: none' labels and switch to the shorter '::' to
> reduce noise.
>
> CC: Jonathan Corbet <[email protected]>
> Signed-off-by: Thorsten Leemhuis <[email protected]>

Assuming the output is the same as before (I didn't run it to verify):

Acked-by: Greg Kroah-Hartman <[email protected]>