[Skiboot] [PATCH 021/110] doc: prettify OPAL_GET_DEVICE_TREE

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

Signed-off-by: Stewart Smith <stewart at linux.ibm.com>
 doc/opal-api/opal-get-device-tree-118.rst | 37 +++++++++++++----------
 1 file changed, 21 insertions(+), 16 deletions(-)

diff --git a/doc/opal-api/opal-get-device-tree-118.rst b/doc/opal-api/opal-get-device-tree-118.rst
index af3fdf7044e1..df00205af310 100644
--- a/doc/opal-api/opal-get-device-tree-118.rst
+++ b/doc/opal-api/opal-get-device-tree-118.rst
@@ -1,36 +1,41 @@
-Get device sub-tree.
+.. code-block:: c
+   #define OPAL_GET_DEVICE_TREE			118
-Parameters: ::
+   int64_t opal_get_device_tree(uint32_t phandle, uint64_t buf, uint64_t len);
+Get device sub-tree.
-	uint32_t phandle: root device node phandle of the device sub-tree
-	uint64_t buf: FDT blob buffer or NULL
-	uint64_t len: length of the FDT blob buffer
+``uint32_t phandle``
+  root device node phandle of the device sub-tree
+``uint64_t buf``
+  FDT blob buffer or NULL
+``uint64_t len``
+  length of the FDT blob buffer
 Retrieve device sub-tree. The root node's phandle is identified by @phandle.
 The typical use is for the kernel to update its device tree following a change
 in hardware (e.g. PCI hotplug).
-Return Codes:
+Return Codes
 FDT blob size
   returned FDT blob buffer size when ``buf`` is NULL
   FDT blob is created successfully
   invalid argument @phandle or @len
   failure creating FDT blob when calculating its size
   not enough room in buffer for device sub-tree
   failure creating FDT blob

More information about the Skiboot mailing list