All of lore.kernel.org
 help / color / mirror / Atom feed
From: Peter Maydell <peter.maydell@linaro.org>
To: qemu-devel@nongnu.org
Cc: "Juan Quintela" <quintela@redhat.com>,
	"Cornelia Huck" <cohuck@redhat.com>,
	"Dr. David Alan Gilbert" <dgilbert@redhat.com>,
	"Stefan Hajnoczi" <stefanha@redhat.com>,
	"Paolo Bonzini" <pbonzini@redhat.com>,
	"Alex Bennée" <alex.bennee@linaro.org>
Subject: [PATCH for-6.1 06/10] docs/system/s390x/protvirt.rst: Format literals correctly
Date: Mon, 26 Jul 2021 15:23:34 +0100	[thread overview]
Message-ID: <20210726142338.31872-7-peter.maydell@linaro.org> (raw)
In-Reply-To: <20210726142338.31872-1-peter.maydell@linaro.org>

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

diff --git a/docs/system/s390x/protvirt.rst b/docs/system/s390x/protvirt.rst
index 0f481043d99..aee63ed7ec9 100644
--- a/docs/system/s390x/protvirt.rst
+++ b/docs/system/s390x/protvirt.rst
@@ -14,11 +14,11 @@ Prerequisites
 To run PVMs, a machine with the Protected Virtualization feature, as
 indicated by the Ultravisor Call facility (stfle bit 158), is
 required. The Ultravisor needs to be initialized at boot by setting
-`prot_virt=1` on the host's kernel command line.
+``prot_virt=1`` on the host's kernel command line.
 
 Running PVMs requires using the KVM hypervisor.
 
-If those requirements are met, the capability `KVM_CAP_S390_PROTECTED`
+If those requirements are met, the capability ``KVM_CAP_S390_PROTECTED``
 will indicate that KVM can support PVMs on that LPAR.
 
 
@@ -26,15 +26,15 @@ Running a Protected Virtual Machine
 -----------------------------------
 
 To run a PVM you will need to select a CPU model which includes the
-`Unpack facility` (stfle bit 161 represented by the feature
-`unpack`/`S390_FEAT_UNPACK`), and add these options to the command line::
+``Unpack facility`` (stfle bit 161 represented by the feature
+``unpack``/``S390_FEAT_UNPACK``), and add these options to the command line::
 
     -object s390-pv-guest,id=pv0 \
     -machine confidential-guest-support=pv0
 
 Adding these options will:
 
-* Ensure the `unpack` facility is available
+* Ensure the ``unpack`` facility is available
 * Enable the IOMMU by default for all I/O devices
 * Initialize the PV mechanism
 
@@ -63,5 +63,5 @@ from the disk boot. This memory layout includes the encrypted
 components (kernel, initrd, cmdline), the stage3a loader and
 metadata. In case this boot method is used, the command line
 options -initrd and -cmdline are ineffective. The preparation of a PVM
-image is done via the `genprotimg` tool from the s390-tools
+image is done via the ``genprotimg`` tool from the s390-tools
 collection.
-- 
2.20.1



  parent reply	other threads:[~2021-07-26 14:26 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-26 14:23 [PATCH for-6.1 00/10] docs: Format literals correctly in rST Peter Maydell
2021-07-26 14:23 ` [PATCH for-6.1 01/10] docs/devel/build-system.rst: Format literals correctly Peter Maydell
2021-07-26 14:23 ` [PATCH for-6.1 02/10] docs/devel/build-system.rst: Correct typo in example code Peter Maydell
2021-07-26 14:51   ` Philippe Mathieu-Daudé
2021-07-26 14:23 ` [PATCH for-6.1 03/10] docs/devel/ebpf_rss.rst: Format literals correctly Peter Maydell
2021-07-26 14:23 ` [PATCH for-6.1 04/10] docs/devel/migration.rst: " Peter Maydell
2021-07-26 14:33   ` Dr. David Alan Gilbert
2021-07-26 14:23 ` [PATCH for-6.1 05/10] docs/devel: " Peter Maydell
2021-07-26 14:23 ` Peter Maydell [this message]
2021-07-26 14:30   ` [PATCH for-6.1 06/10] docs/system/s390x/protvirt.rst: " Cornelia Huck
2021-07-26 14:23 ` [PATCH for-6.1 07/10] docs/system/arm/cpu-features.rst: " Peter Maydell
2021-07-26 14:23 ` [PATCH for-6.1 08/10] docs: " Peter Maydell
2021-07-26 14:23 ` [PATCH for-6.1 09/10] docs/about/removed-features: Fix markup error Peter Maydell
2021-07-26 14:50   ` Philippe Mathieu-Daudé
2021-07-26 14:23 ` [PATCH for-6.1 10/10] docs/tools/virtiofsd.rst: Delete stray backtick Peter Maydell
2021-07-26 14:35   ` Dr. David Alan Gilbert
2021-07-26 23:09 ` [PATCH for-6.1 00/10] docs: Format literals correctly in rST Richard Henderson

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=20210726142338.31872-7-peter.maydell@linaro.org \
    --to=peter.maydell@linaro.org \
    --cc=alex.bennee@linaro.org \
    --cc=cohuck@redhat.com \
    --cc=dgilbert@redhat.com \
    --cc=pbonzini@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=quintela@redhat.com \
    --cc=stefanha@redhat.com \
    /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.