[Skiboot] [PATCH 075/110] doc: prettify OPAL_PCI_SET_PELTV

Stewart Smith stewart at linux.ibm.com
Fri May 31 16:13:16 AEST 2019


Signed-off-by: Stewart Smith <stewart at linux.ibm.com>
---
 doc/opal-api/opal-pci-set-peltv-32.rst | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

diff --git a/doc/opal-api/opal-pci-set-peltv-32.rst b/doc/opal-api/opal-pci-set-peltv-32.rst
index 9cc13a24645e..acb2d479a2fe 100644
--- a/doc/opal-api/opal-pci-set-peltv-32.rst
+++ b/doc/opal-api/opal-pci-set-peltv-32.rst
@@ -1,17 +1,19 @@
+.. _OPAL_PCI_SET_PELTV:
+
 OPAL_PCI_SET_PELTV
 ==================
-::
+
+.. code-block:: c
 
    #define OPAL_PCI_SET_PELTV			32
 
+   int64_t opal_pci_set_peltv(uint64_t phb_id, uint32_t parent_pe,
+                              uint32_t child_pe, uint8_t state);
+
 **WARNING:** This documentation comes from an old source and is possibly not up
 to date with OPALv3. Rely on this documentation only as a starting point,
 use the source (and update the docs).
 
-::
-
-   static int64_t opal_pci_set_peltv(uint64_t phb_id, uint32_t parent_pe,
-				  uint32_t child_pe, uint8_t state)
 
 This call sets the PELTV of a parent PE to add or remove a PE number as a PE
 within that parent PE domain. The host must call this function for each child
@@ -38,7 +40,7 @@ of a parent PE.
   and the upstream bridge PE of that switch -- an ERR_Fatal from either bridge
   should result in a collateral freeze of that device PE.
 
-::
+.. code-block:: c
 
    enum OpalPeltvAction {
 	OPAL_REMOVE_PE_FROM_DOMAIN = 0,
@@ -52,7 +54,9 @@ PE when the state argument is '1'. OPAL clears the PELTV bit in all RTT
 entries for the parent PE when the state argument is '0' and setting the child
 PE bit in the parent PELTV results in an all-zeros value for that PELTV.
 
-Return value: ::
+Return value:
+
+.. code-block:: c
 
 	if (!phb)
 		return OPAL_PARAMETER;
-- 
2.21.0



More information about the Skiboot mailing list