diff mbox series

[028/110] doc: make OPAL_TEST docs pretty

Message ID 20190531061351.22973-29-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-test-0.rst | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/doc/opal-api/opal-test-0.rst b/doc/opal-api/opal-test-0.rst
index ff56abaa87f6..107f5ce72a45 100644
--- a/doc/opal-api/opal-test-0.rst
+++ b/doc/opal-api/opal-test-0.rst
@@ -1,12 +1,16 @@ 
+.. _OPAL_TEST:
+
 OPAL_TEST
 =========
 
-OPAL_TEST is a REQUIRED call for OPAL and conforming implementations MUST
+:ref:`OPAL_TEST` is a REQUIRED call for OPAL and conforming implementations MUST
 have it.
 
 It is designed to test basic OPAL call functionality.
 
-Token: ::
+Token:
+
+.. code-block:: c
 
   #define OPAL_TEST				0
 
@@ -25,9 +29,11 @@  Returns
 
 Function
 --------
-OPAL_TEST MAY print a string to the OPAL log with the value of argument.
+:ref:`OPAL_TEST` MAY print a string to the OPAL log with the value of argument.
+
+For example, the reference implementation (skiboot) implements :ref:`OPAL_TEST` as:
 
-For example, the reference implementation (skiboot) implements OPAL_TEST as: ::
+.. code-block:: c
 
   static uint64_t opal_test_func(uint64_t arg)
   {