diff mbox series

[012/110] doc: prettify opal IMC counters calls

Message ID 20190531061351.22973-13-stewart@linux.ibm.com
State Accepted
Headers show
Series Big documentation cleanup/expansion | expand

Commit Message

Stewart Smith May 31, 2019, 6:12 a.m. UTC 
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
---
 doc/opal-api/opal-imc-counters.rst | 32 ++++++++++++++----------------
 1 file changed, 15 insertions(+), 17 deletions(-)
diff mbox series

Patch

diff --git a/doc/opal-api/opal-imc-counters.rst b/doc/opal-api/opal-imc-counters.rst
index ee06d7065cf4..85ade3f5aef5 100644
--- a/doc/opal-api/opal-imc-counters.rst
+++ b/doc/opal-api/opal-imc-counters.rst
@@ -1,7 +1,9 @@ 
 .. _opal-imc-counters:
 
+.. _OPAL_IMC_COUNTERS_INIT:
+
 OPAL_IMC_COUNTERS_INIT
-==============================
+======================
 OPAL call interface to initialize In-memory collection
 infrastructure. Call does multiple scom writes on each
 invocation for Core/Trace IMC initialization. And for the
@@ -37,18 +39,17 @@  Parameters
 Returns
 -------
 
-OPAL_PARAMETER
+:ref:`OPAL_PARAMETER`
   In case of  unsupported ``type``
-
-OPAL_HARDWARE
+:ref:`OPAL_HARDWARE`
   If any error in setting up the hardware.
-
-OPAL_SUCCESS
+:ref:`OPAL_SUCCESS`
   On succesfully initialized or even if init operation is a no-op.
 
+.. _OPAL_IMC_COUNTERS_START:
 
 OPAL_IMC_COUNTERS_START
-============================
+=======================
 OPAL call interface for starting the In-Memory Collection
 counters for a specified domain (NEST/CORE/TRACE).
 
@@ -65,15 +66,14 @@  Parameters
 Returns
 -------
 
-OPAL_PARAMETER
+:ref:`OPAL_PARAMETER`
   In case of  Unsupported ``type``
-
-OPAL_HARDWARE
+:ref:`OPAL_HARDWARE`
   If any error in setting up the hardware.
-
-OPAL_SUCCESS
+:ref:`OPAL_SUCCESS`
   On successful execution of the operation for the given ``type``.
 
+.. _OPAL_IMC_COUNTERS_STOP:
 
 OPAL_IMC_COUNTERS_STOP
 ======================
@@ -96,11 +96,9 @@  Parameters
 Returns
 -------
 
-OPAL_PARAMETER
+:ref:`OPAL_PARAMETER`
   In case of  Unsupported ``type``
-
-OPAL_HARDWARE
+:ref:`OPAL_HARDWARE`
   If any error in setting up the hardware.
-
-OPAL_SUCCESS
+:ref:`OPAL_SUCCESS`
   On successful execution of the operation for the given ``type``.