[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 12/21] docs/system/s390x/protvirt.rst: Format literals correctly
From: |
Peter Maydell |
Subject: |
[PULL 12/21] docs/system/s390x/protvirt.rst: Format literals correctly |
Date: |
Mon, 2 Aug 2021 12:58:03 +0100 |
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>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Acked-by: Cornelia Huck <cohuck@redhat.com>
Message-id: 20210726142338.31872-7-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
- [PULL 01/21] docs: Add documentation of Arm 'mainstone' board, (continued)
- [PULL 01/21] docs: Add documentation of Arm 'mainstone' board, Peter Maydell, 2021/08/02
- [PULL 04/21] MAINTAINERS: Don't list Andrzej Zaborowski for various components, Peter Maydell, 2021/08/02
- [PULL 06/21] docs: Move licence/copyright from HTML output to rST comments, Peter Maydell, 2021/08/02
- [PULL 02/21] docs: Add documentation of Arm 'kzm' board, Peter Maydell, 2021/08/02
- [PULL 03/21] docs: Add documentation of Arm 'imx25-pdk' board, Peter Maydell, 2021/08/02
- [PULL 05/21] docs: Remove stale TODO comments about license and version, Peter Maydell, 2021/08/02
- [PULL 08/21] docs/devel/build-system.rst: Correct typo in example code, Peter Maydell, 2021/08/02
- [PULL 09/21] docs/devel/ebpf_rss.rst: Format literals correctly, Peter Maydell, 2021/08/02
- [PULL 10/21] docs/devel/migration.rst: Format literals correctly, Peter Maydell, 2021/08/02
- [PULL 07/21] docs/devel/build-system.rst: Format literals correctly, Peter Maydell, 2021/08/02
- [PULL 12/21] docs/system/s390x/protvirt.rst: Format literals correctly,
Peter Maydell <=
- [PULL 14/21] docs: Format literals correctly, Peter Maydell, 2021/08/02
- [PULL 16/21] docs/tools/virtiofsd.rst: Delete stray backtick, Peter Maydell, 2021/08/02
- [PULL 11/21] docs/devel: Format literals correctly, Peter Maydell, 2021/08/02
- [PULL 13/21] docs/system/arm/cpu-features.rst: Format literals correctly, Peter Maydell, 2021/08/02
- [PULL 17/21] hw/arm/boot: Report error if there is no fw_cfg device in the machine, Peter Maydell, 2021/08/02
- [PULL 15/21] docs/about/removed-features: Fix markup error, Peter Maydell, 2021/08/02
- [PULL 18/21] docs: Move bootindex.txt into system section and rstify, Peter Maydell, 2021/08/02
- [PULL 21/21] docs: Move user-facing barrier docs into system manual, Peter Maydell, 2021/08/02
- [PULL 19/21] docs: Move the protocol part of barrier.txt into interop, Peter Maydell, 2021/08/02
- [PULL 20/21] ui/input-barrier: Move TODOs from barrier.txt to a comment, Peter Maydell, 2021/08/02