[Skiboot] [PATCH 1/4] doc/opal-api: fix some formatting in OPAL_CONSOLE read/write
stewart at linux.vnet.ibm.com
Tue Aug 9 17:50:51 AEST 2016
Signed-off-by: Stewart Smith <stewart at linux.vnet.ibm.com>
doc/opal-api/opal-console-read-write-1-2.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/doc/opal-api/opal-console-read-write-1-2.rst b/doc/opal-api/opal-console-read-write-1-2.rst
index 73832dc..6d6c0ff 100644
@@ -32,8 +32,8 @@ Returns: ::
OPAL_CLOSED - console device closed
OPAL_BUSY_EVENT - unable to write any of buffer
-term_number is the terminal number as represented in the device tree.
-length is a pointer to the length of buffer.
+``term_number`` is the terminal number as represented in the device tree.
+``length`` is a pointer to the length of buffer.
A conforming implementation SHOULD try to NOT do partial writes, although
partial writes and not writing anything are valid.
@@ -51,7 +51,7 @@ Returns: ::
OPAL_PARAMETER - invalid term_number
-Returns the available buffer length for OPAL_CONSOLE_WRITE in *length.
+Returns the available buffer length for OPAL_CONSOLE_WRITE in ``length``.
This call can be used to help work out if there is sufficient buffer
space to write your full message to the console with OPAL_CONSOLE_WRITE.
More information about the Skiboot