[RFC,v1,1/3] docs: stable-kernel-rules: mention other usages for stable tag comments

  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(-)
  

On Mon, Jul 10, 2023 at 07:10:11PM +0200, Thorsten Leemhuis 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

Is that how a ';' is really used?  I never can remember, so it's an
honest question here :)

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

This looks great to me, so I'll be glad to take it.

thanks,

greg k-h
  

On 10.07.23 21:43, Greg KH wrote:
> On Mon, Jul 10, 2023 at 07:10:11PM +0200, Thorsten Leemhuis 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
> 
> Is that how a ';' is really used?  I never can remember, so it's an
> honest question here :)

Ha, better ask a native speaker or your favorite internet search engine
for advice and not someone from Germany that in school was always bad at
both German and English. ;)

But to answer the question: I think it is used this way in English "to
connect related, but independent clauses". But the relation is not that
strong or important here; I also tend use semicolons a bit too much, so
I'll just drop it for v2.

> [...]
> This looks great to me, so I'll be glad to take it.

thx!

Ciao, Thorsten
  

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
  

On 11.07.23 12:15, Jani Nikula wrote:
> On Mon, 10 Jul 2023, Thorsten Leemhuis <linux@leemhuis.info> wrote:
> [...]
>> +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.

I had similar concerns, to which Greg replied: ```my "script" is me
reviewing each patch :)```

FWIW, that was here:
https://lore.kernel.org/all/2023061936-eatable-grumbling-f3c1@gregkh/

Ciao, Thorsten