diff mbox series

[101/110] doc: prettify OPAL_CHECK_ASYNC_COMPLETION

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

Checks

Context Check Description
snowpatch_ozlabs/apply_patch success Successfully applied on branch master (76f7316bc8fc8a18fdbfcbc0e1fe1bb992d2a7d7)
snowpatch_ozlabs/snowpatch_job_snowpatch-skiboot fail Test snowpatch/job/snowpatch-skiboot on branch master
snowpatch_ozlabs/snowpatch_job_snowpatch-skiboot-dco success Signed-off-by present

Commit Message

Stewart Smith May 31, 2019, 6:13 a.m. UTC 
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
---
 doc/opal-api/opal-check-async-completion-86.rst | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)
diff mbox series

Patch

diff --git a/doc/opal-api/opal-check-async-completion-86.rst b/doc/opal-api/opal-check-async-completion-86.rst
index 9c1505f5acbe..1744c69284bb 100644
--- a/doc/opal-api/opal-check-async-completion-86.rst
+++ b/doc/opal-api/opal-check-async-completion-86.rst
@@ -1,10 +1,15 @@ 
+.. _OPAL_CHECK_ASYNC_COMPLETION:
+
 OPAL_CHECK_ASYNC_COMPLETION
 ===========================
 
-OPAL_CHECK_ASYNC_COMPLETION checks if an async OPAL pending message was completed. (see :ref:`opal-messages`).
+:ref:`OPAL_CHECK_ASYNC_COMPLETION` checks if an async OPAL pending message was
+completed. (see :ref:`opal-messages`).
 
 .. code-block:: c
 
+   #define OPAL_CHECK_ASYNC_COMPLETION		86
+
    int64_t opal_check_completion(uint64_t *buffer, uint64_t size, uint64_t token);
 
 Parameters:
@@ -16,15 +21,15 @@  size
 token
   async message token
 
+Currently unused by Linux, but it is used by FreeBSD.
+
 
 Return values
 -------------
 
-OPAL_PARAMETER
+:ref:`OPAL_PARAMETER`
   buffer parameter is an invalid pointer (NULL or > top of RAM).
-
-OPAL_SUCCESS
+:ref:`OPAL_SUCCESS`
   message successfully copied to buffer.
-
-OPAL_BUSY
+:ref:`OPAL_BUSY`
   message is still pending and should be re-checked later.