Re: [PATCH for-6.1 06/10] docs/system/s390x/protvirt.rst: Format literals correctly

From: Cornelia Huck <cohuck@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>, qemu-devel@nongnu.org
Cc: "Paolo Bonzini" <pbonzini@redhat.com>,
	"Alex Bennée" <alex.bennee@linaro.org>,
	"Dr. David Alan Gilbert" <dgilbert@redhat.com>,
	"Stefan Hajnoczi" <stefanha@redhat.com>,
	"Juan Quintela" <quintela@redhat.com>
Subject: Re: [PATCH for-6.1 06/10] docs/system/s390x/protvirt.rst: Format literals correctly
Date: Mon, 26 Jul 2021 16:30:41 +0200	[thread overview]
Message-ID: <875ywx5er2.fsf@redhat.com> (raw)
In-Reply-To: <20210726142338.31872-7-peter.maydell@linaro.org>

On Mon, Jul 26 2021, Peter Maydell <peter.maydell@linaro.org> wrote:

> In rST markup, single backticks `like this` represent "interpreted
> text", which can be handled as a bunch of different things if tagged
> with a specific "role":
> https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpreted-text
> (the most common one for us is "reference to a URL, which gets
> hyperlinked").
>
> The default "role" if none is specified is "title_reference",
> intended for references to book or article titles, and it renders
> into the HTML as <cite>...</cite> (usually comes out as italics).
>
> To format a literal (generally rendered as fixed-width font),
> double-backticks are required.
>
> protvirt.rst consistently uses single backticks when double backticks
> are required; correct it.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
>  docs/system/s390x/protvirt.rst | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)

Acked-by: Cornelia Huck <cohuck@redhat.com>