From: Jonathan Corbet <corbet@lwn.net>
To: Salvatore Bonaccorso <carnil@debian.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Sasha Levin <sashal@kernel.org>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Salvatore Bonaccorso <carnil@debian.org>
Subject: Re: [PATCH] Documentation: stable: Document alternative for referring upstream commit hash
Date: Tue, 09 Aug 2022 06:54:59 -0600 [thread overview]
Message-ID: <8735e5a864.fsf@meer.lwn.net> (raw)
In-Reply-To: <20220809045543.2049293-1-carnil@debian.org>
Salvatore Bonaccorso <carnil@debian.org> 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 <carnil@debian.org>
> ---
> Documentation/process/stable-kernel-rules.rst | 6 ++++++
> 1 file changed, 6 insertions(+)
So this is a nit but...
> 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> ]
Can this just be:
or alternatively::
[ Upstream commit <sha1> ]
That extra RST markup just clutters things without any advantage.
Thanks,
jon
next prev parent reply other threads:[~2022-08-09 12:55 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-09 4:55 [PATCH] Documentation: stable: Document alternative for referring upstream commit hash Salvatore Bonaccorso
2022-08-09 8:30 ` Bagas Sanjaya
2022-08-09 8:44 ` Greg Kroah-Hartman
2022-08-09 12:54 ` Jonathan Corbet [this message]
2022-08-09 13:37 ` Salvatore Bonaccorso
2022-08-26 8:27 ` Salvatore Bonaccorso
2022-09-01 15:59 ` Greg Kroah-Hartman
2022-09-01 18:45 ` Salvatore Bonaccorso
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8735e5a864.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=carnil@debian.org \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=sashal@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.