From: Bagas Sanjaya <bagasdotme@gmail.com>
To: linux-doc@vger.kernel.org
Cc: Heiko Carstens <hca@linux.ibm.com>,
Vasily Gorbik <gor@linux.ibm.com>,
Alexander Gordeev <agordeev@linux.ibm.com>,
Christian Borntraeger <borntraeger@linux.ibm.com>,
Sven Schnelle <svens@linux.ibm.com>,
Jonathan Corbet <corbet@lwn.net>,
Halil Pasic <pasic@linux.ibm.com>,
Tony Krowiak <akrowiak@linux.ibm.com>,
Jason Herne <jjherne@linux.ibm.com>,
linux-s390@vger.kernel.org, linux-kernel@vger.kernel.org,
Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH 2/8] Documentation: s390: use note directive for remaining notes
Date: Fri, 22 Jul 2022 15:49:41 +0700 [thread overview]
Message-ID: <20220722084946.22965-3-bagasdotme@gmail.com> (raw)
In-Reply-To: <20220722084946.22965-1-bagasdotme@gmail.com>
Convert remaining vfio-ap.rst notes to use note directive, while also
fix maximum sysfs notes being rendered as definition lists instead.
Fixes: cb269e0aba7c3f ("s390/vfio-ap: update docs to include dynamic config support")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/s390/vfio-ap.rst | 51 +++++++++++++++++++++-------------
1 file changed, 31 insertions(+), 20 deletions(-)
diff --git a/Documentation/s390/vfio-ap.rst b/Documentation/s390/vfio-ap.rst
index 7aea0afe2ef390..5bf15d117c4ba0 100644
--- a/Documentation/s390/vfio-ap.rst
+++ b/Documentation/s390/vfio-ap.rst
@@ -475,24 +475,29 @@ following CPU model features:
guest. This facility can be made available to the guest only if it is
available on the host (i.e., facility bit 65 is set).
-Note: If the user chooses to specify a CPU model different than the 'host'
-model to QEMU, the CPU model features and facilities need to be turned on
-explicitly; for example::
+ .. note::
- /usr/bin/qemu-system-s390x ... -cpu z13,ap=on,apqci=on,apft=on,apqi=on
+ If the user chooses to specify a CPU model different than the 'host'
+ model to QEMU, the CPU model features and facilities need to be turned
+ on explicitly; for example::
-A guest can be precluded from using AP features/facilities by turning them off
-explicitly; for example::
+ /usr/bin/qemu-system-s390x ... -cpu z13,ap=on,apqci=on,apft=on,apqi=on
- /usr/bin/qemu-system-s390x ... -cpu host,ap=off,apqci=off,apft=off,apqi=off
+ A guest can be precluded from using AP features/facilities by turning
+ them off explicitly; for example::
-Note: If the APFT facility is turned off (apft=off) for the guest, the guest
-will not see any AP devices. The zcrypt device drivers on the guest that
-register for type 10 and newer AP devices - i.e., the cex4card and cex4queue
-device drivers - need the APFT facility to ascertain the facilities installed on
-a given AP device. If the APFT facility is not installed on the guest, then no
-adapter or domain devices will get created by the AP bus running on the
-guest because only type 10 and newer devices can be configured for guest use.
+ /usr/bin/qemu-system-s390x ... -cpu host,ap=off,apqci=off,apft=off,apqi=off
+
+ .. note::
+
+ If the APFT facility is turned off (apft=off) for the guest, the guest
+ will not see any AP devices. The zcrypt device drivers on the guest that
+ register for type 10 and newer AP devices - i.e., the cex4card and
+ cex4queue device drivers - need the APFT facility to ascertain the
+ facilities installed on a given AP device. If the APFT facility is not
+ installed on the guest, then no adapter or domain devices will get
+ created by the AP bus running on the guest because only type 10 and
+ newer devices can be configured for guest use.
Example
=======
@@ -802,8 +807,10 @@ Securing the APQNs for our example
----------------unassign_control_domain
----------------unassign_domain
- Note *****: The vfio_ap mdevs do not persist across reboots unless the
- mdevctl tool is used to create and persist them.
+ .. note::
+
+ The vfio_ap mdevs do not persist across reboots unless the
+ mdevctl tool is used to create and persist them.
4. The administrator now needs to configure the matrixes for the mediated
devices $uuid1 (for Guest1), $uuid2 (for Guest2) and $uuid3 (for Guest3).
@@ -849,8 +856,10 @@ Securing the APQNs for our example
higher than the maximum is specified, the operation will terminate with
an error (ENODEV).
- Note: The maximum adapter number can be obtained via the sysfs
- /sys/bus/ap/ap_max_adapter_id attribute file.
+ .. note::
+
+ The maximum adapter number can be obtained via the sysfs
+ /sys/bus/ap/ap_max_adapter_id
* Each APQN derived from the Cartesian product of the APID of the adapter
being assigned and the APQIs of the domains previously assigned:
@@ -875,8 +884,10 @@ Securing the APQNs for our example
higher than the maximum is specified, the operation will terminate with
an error (ENODEV).
- Note: The maximum domain number can be obtained via the sysfs
- /sys/bus/ap/ap_max_domain_id attribute file.
+ .. note::
+
+ The maximum domain number can be obtained via the sysfs
+ /sys/bus/ap/ap_max_domain_id
* Each APQN derived from the Cartesian product of the APQI of the domain
being assigned and the APIDs of the adapters previously assigned:
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2022-07-22 8:50 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-22 8:49 [PATCH 0/8] Documentation: s390: documentation fixes for vfio_ap driver Bagas Sanjaya
2022-07-22 8:49 ` [PATCH 1/8] Documentation: s390: Use note directive for changing mask note Bagas Sanjaya
2022-07-22 8:49 ` Bagas Sanjaya [this message]
2022-07-22 8:49 ` [PATCH 3/8] Documentation: s390: sync heading underlines Bagas Sanjaya
2022-07-22 8:49 ` [PATCH 4/8] Documentation: s390: use code blocks for virsh and qemu output Bagas Sanjaya
2022-07-22 8:49 ` [PATCH 5/8] Documentation: s390: use code block for structs Bagas Sanjaya
2022-07-22 8:49 ` [PATCH 6/8] Documentation: s390: escape *kvm->arch.crypto.pqap_hook pointer inside inline code Bagas Sanjaya
2022-07-22 8:49 ` [PATCH 7/8] Documentation: s390: extend underline for matrix devices lock Bagas Sanjaya
2022-07-22 8:49 ` [PATCH 8/8] Documentation: s390: add vfio-ap-locking documentation to table of contents index Bagas Sanjaya
2022-07-22 12:02 ` [PATCH 0/8] Documentation: s390: documentation fixes for vfio_ap driver Alexander Gordeev
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=20220722084946.22965-3-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=agordeev@linux.ibm.com \
--cc=akrowiak@linux.ibm.com \
--cc=borntraeger@linux.ibm.com \
--cc=corbet@lwn.net \
--cc=gor@linux.ibm.com \
--cc=hca@linux.ibm.com \
--cc=jjherne@linux.ibm.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-s390@vger.kernel.org \
--cc=pasic@linux.ibm.com \
--cc=svens@linux.ibm.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).