[Skiboot] [PATCH] doc: fix definition lists in opal-imc-counters

Stewart Smith stewart at linux.ibm.com
Thu Feb 21 17:35:45 AEDT 2019


Signed-off-by: Stewart Smith <stewart at linux.ibm.com>
---
 doc/opal-api/opal-imc-counters.rst | 38 ++++++++++++++++++++++--------
 1 file changed, 28 insertions(+), 10 deletions(-)

diff --git a/doc/opal-api/opal-imc-counters.rst b/doc/opal-api/opal-imc-counters.rst
index d0b4d960a715..0caef49155d3 100644
--- a/doc/opal-api/opal-imc-counters.rst
+++ b/doc/opal-api/opal-imc-counters.rst
@@ -35,9 +35,15 @@ Parameters
 
 Returns
 -------
-OPAL_PARAMETER - In case of  unsupported ``type``
-OPAL_HARDWARE  - If any error in setting up the hardware.
-OPAL_SUCCESS   - On succesfully initialized or even if init operation is a no-op.
+
+OPAL_PARAMETER
+  In case of  unsupported ``type``
+
+OPAL_HARDWARE
+  If any error in setting up the hardware.
+
+OPAL_SUCCESS
+  On succesfully initialized or even if init operation is a no-op.
 
 
 OPAL_IMC_COUNTERS_START
@@ -57,13 +63,19 @@ Parameters
 
 Returns
 -------
-OPAL_PARAMETER - In case of  Unsupported ``type``
-OPAL_HARDWARE  - If any error in setting up the hardware.
-OPAL_SUCCESS   - On successful execution of the operation for the given ``type``.
+
+OPAL_PARAMETER
+  In case of  Unsupported ``type``
+
+OPAL_HARDWARE
+  If any error in setting up the hardware.
+
+OPAL_SUCCESS
+  On successful execution of the operation for the given ``type``.
 
 
 OPAL_IMC_COUNTERS_STOP
-===========================
+======================
 OPAL call interface for stoping In-Memory
 Collection counters for a specified domain (NEST/CORE).
 STOP should always be called after a related START.
@@ -82,6 +94,12 @@ Parameters
 
 Returns
 -------
-OPAL_PARAMETER - In case of  Unsupported ``type``
-OPAL_HARDWARE  - If any error in setting up the hardware.
-OPAL_SUCCESS   - On successful execution of the operation for the given ``type``.
+
+OPAL_PARAMETER
+  In case of  Unsupported ``type``
+
+OPAL_HARDWARE
+  If any error in setting up the hardware.
+
+OPAL_SUCCESS
+  On successful execution of the operation for the given ``type``.
-- 
2.20.1



More information about the Skiboot mailing list