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@xxxxxxxxx>
---
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
