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

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

Documentation/process/stable-kernel-rules.rst

+102 −123
Original line number Diff line number Diff line
@@ -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: stable@vger.kernel.org



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: <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
@@ -91,9 +86,7 @@ comment to pass arbitrary or predefined notes: 
    Cc: <stable@vger.kernel.org> # 3.3.x

    Signed-off-by: Ingo Molnar <mingo@elte.hu>



   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
@@ -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

  patches present in the series itself. For example, if you have the following

   patch series:



   .. code-block:: none

  patch series::



    patch1

    patch2
@@ -113,15 +104,11 @@ comment to pass arbitrary or predefined notes: 
  prerequisite of patch2 if you have already marked patch1 for stable

  inclusion.



 * Point out kernel version prerequisites:



   .. code-block:: none

* Point out kernel version prerequisites::



    Cc: <stable@vger.kernel.org> # 3.3.x



   The tag has the meaning of:



   .. code-block:: none

  The tag has the meaning of::



    git cherry-pick <this commit>
@@ -130,15 +117,11 @@ comment to pass arbitrary or predefined notes: 
  Note, such tagging is unnecessary if the stable team can derive the

  appropriate versions from Fixes: tags.



 * Delay pick up of patches:



   .. code-block:: none

* Delay pick up of patches::



    Cc: <stable@vger.kernel.org> # after -rc3



 * Point out known problems:



   .. code-block:: none

* Point out known problems::



    Cc: <stable@vger.kernel.org> # see patch description, needs adjustments for <= 6.3
@@ -160,15 +143,11 @@ Option 3 
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

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> ]