Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Jani Nikula <jani.nikula@linux.intel.com>
To:     Thorsten Leemhuis <linux@leemhuis.info>,
        Greg KH <gregkh@linuxfoundation.org>, stable@vger.kernel.org
Cc:     linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
        Sasha Levin <sashal@kernel.org>,
        Jonathan Corbet <corbet@lwn.net>
Subject: Re: [RFC PATCH v1 1/3] docs: stable-kernel-rules: mention other
 usages for stable tag comments
In-Reply-To: <d30686781c47c83927e0a41f6a1167a679fa822c.1689008220.git.linux@leemhuis.info>
Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo
References: <cover.1689008220.git.linux@leemhuis.info>
 <d30686781c47c83927e0a41f6a1167a679fa822c.1689008220.git.linux@leemhuis.info>
Date:   Tue, 11 Jul 2023 13:15:44 +0300
Message-ID: <871qheiwj3.fsf@intel.com>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: bulk

On Mon, 10 Jul 2023, Thorsten Leemhuis <linux@leemhuis.info> wrote:
> Document how to delay backporting or send a note to the stable team
> using shell-style inline comments attached to stable tags.
>
> 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>
> ---
>  Documentation/process/stable-kernel-rules.rst | 22 ++++++++++++++++---
>  1 file changed, 19 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/process/stable-kernel-rules.rst b/Documentation/process/stable-kernel-rules.rst
> index 51df1197d5ab..6e4026dd6882 100644
> --- a/Documentation/process/stable-kernel-rules.rst
> +++ b/Documentation/process/stable-kernel-rules.rst
> @@ -55,9 +55,10 @@ To have the patch automatically included in the stable tree, add the tag
>  
>       Cc: stable@vger.kernel.org
>  
> -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.
> +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.
>  
>  .. _option_2:
>  
> @@ -139,6 +140,21 @@ The tag has the meaning of:
>  
>  For each "-stable" tree starting with the specified version.
>  
> +To delay pick up of patches submitted via :ref:`option_1`, use the following
> +format:
> +
> +.. 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:
> +
> +.. code-block:: none
> +
> +     Cc: <stable@vger.kernel.org> # see patch description, needs adjustments for >= 6.3
> +

To me, this seems like promoting *any* free text after the #, making it
harder to parse in scripts.

Of course, I'm only ever producing this, and never consuming, so if the
manual reading is fine for the stable developers, who am I to argue.


BR,
Jani.


>  Following the submission:
>  
>   - The sender will receive an ACK when the patch has been accepted into the

-- 
Jani Nikula, Intel Open Source Graphics Center