diff mbox series

[022/110] doc: prettify OPAL_PCI_GET_PRESENCE_STATE

Message ID 20190531061351.22973-23-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-pci-get-presence-state-119.rst | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)
diff mbox series

Patch

diff --git a/doc/opal-api/opal-pci-get-presence-state-119.rst b/doc/opal-api/opal-pci-get-presence-state-119.rst
index 23ea831910e3..b31df47a8b36 100644
--- a/doc/opal-api/opal-pci-get-presence-state-119.rst
+++ b/doc/opal-api/opal-pci-get-presence-state-119.rst
@@ -1,6 +1,14 @@ 
+.. _OPAL_PCI_GET_PRESENCE_STATE:
+
 OPAL_PCI_GET_PRESENCE_STATE
 ===========================
 
+.. code-block: c
+
+   #define OPAL_PCI_GET_PRESENCE_STATE		119
+
+   int64_t opal_pci_get_presence_state(uint64_t id, uint64_t data);
+
 Get PCI slot presence state
 
 Parameters
@@ -23,11 +31,9 @@  state is stored in buffer pointed by @data.
 
 Return Codes
 ------------
-OPAL_SUCCESS
+:ref:`OPAL_SUCCESS`
   PCI slot's presence state is retrieved successfully
-
-OPAL_PARAMETER
+:ref:`OPAL_PARAMETER`
   The indicated PCI slot isn't found
-
-OPAL_UNSUPPORTED
+:ref:`OPAL_UNSUPPORTED`
   Presence retrieval not supported on the PCI slot