[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH for-6.1 06/10] docs/system/s390x/protvirt.rst: Format literal
From: |
Cornelia Huck |
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 |
User-agent: |
Notmuch/0.32.1 (https://notmuchmail.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>
- [PATCH for-6.1 00/10] docs: Format literals correctly in rST, Peter Maydell, 2021/07/26
- [PATCH for-6.1 03/10] docs/devel/ebpf_rss.rst: Format literals correctly, Peter Maydell, 2021/07/26
- [PATCH for-6.1 04/10] docs/devel/migration.rst: Format literals correctly, Peter Maydell, 2021/07/26
- [PATCH for-6.1 06/10] docs/system/s390x/protvirt.rst: Format literals correctly, Peter Maydell, 2021/07/26
- Re: [PATCH for-6.1 06/10] docs/system/s390x/protvirt.rst: Format literals correctly,
Cornelia Huck <=
- [PATCH for-6.1 02/10] docs/devel/build-system.rst: Correct typo in example code, Peter Maydell, 2021/07/26
- [PATCH for-6.1 01/10] docs/devel/build-system.rst: Format literals correctly, Peter Maydell, 2021/07/26
- [PATCH for-6.1 05/10] docs/devel: Format literals correctly, Peter Maydell, 2021/07/26
- [PATCH for-6.1 08/10] docs: Format literals correctly, Peter Maydell, 2021/07/26
- [PATCH for-6.1 09/10] docs/about/removed-features: Fix markup error, Peter Maydell, 2021/07/26
- [PATCH for-6.1 10/10] docs/tools/virtiofsd.rst: Delete stray backtick, Peter Maydell, 2021/07/26
- [PATCH for-6.1 07/10] docs/system/arm/cpu-features.rst: Format literals correctly, Peter Maydell, 2021/07/26