2022-09-01 18:50:14

by Salvatore Bonaccorso

Subject: [PATCH v3] Documentation: stable: Document alternative for referring upstream commit hash

Additionally to the "commit <sha1> upstream." variant, "[ Upstream
commit <sha1> ]" is used as well as alternative to refer to the upstream
commit hash.

Signed-off-by: Salvatore Bonaccorso <[email protected]>
---
Changes in v3:
- Revert to initial version as not adding the code-block:: none will
reformat the block differently than the first variant.

Changes in v2:
- Drop extra RST markup which just only clutters things without any
advantage.

Documentation/process/stable-kernel-rules.rst | 6 ++++++
1 file changed, 6 insertions(+)

diff --git a/Documentation/process/stable-kernel-rules.rst b/Documentation/process/stable-kernel-rules.rst
index c61865e91f52..2fd8aa593a28 100644
--- a/Documentation/process/stable-kernel-rules.rst
+++ b/Documentation/process/stable-kernel-rules.rst
@@ -97,6 +97,12 @@ text, like this:

commit <sha1> upstream.

+or alternatively:
+
+.. code-block:: none
+
+ [ Upstream commit <sha1> ]
+
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:
--
2.37.2

2022-09-21 20:47:08

by Jonathan Corbet

Subject: Re: [PATCH v3] Documentation: stable: Document alternative for referring upstream commit hash

Salvatore Bonaccorso <[email protected]> writes:

> Additionally to the "commit <sha1> upstream." variant, "[ Upstream
> commit <sha1> ]" is used as well as alternative to refer to the upstream
> commit hash.
>
> Signed-off-by: Salvatore Bonaccorso <[email protected]>
> ---
> Changes in v3:
> - Revert to initial version as not adding the code-block:: none will
> reformat the block differently than the first variant.
>
> Changes in v2:
> - Drop extra RST markup which just only clutters things without any
> advantage.
>
> Documentation/process/stable-kernel-rules.rst | 6 ++++++
> 1 file changed, 6 insertions(+)
>
> diff --git a/Documentation/process/stable-kernel-rules.rst b/Documentation/process/stable-kernel-rules.rst
> index c61865e91f52..2fd8aa593a28 100644
> --- a/Documentation/process/stable-kernel-rules.rst
> +++ b/Documentation/process/stable-kernel-rules.rst
> @@ -97,6 +97,12 @@ text, like this:
>
> commit <sha1> upstream.
>
> +or alternatively:
> +
> +.. code-block:: none
> +
> + [ Upstream commit <sha1> ]
> +
> 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:

Applied, thanks.

jon