diff options
| author | Stewart Smith <stewart@linux.vnet.ibm.com> | 2016-08-09 17:35:34 +1000 |
|---|---|---|
| committer | Stewart Smith <stewart@linux.vnet.ibm.com> | 2016-08-09 17:35:34 +1000 |
| commit | 98fa85b5022d80849a0acf0b50d7f9a8f96bb942 (patch) | |
| tree | 0f2d02b2632a9badab64300e5ade1777c638136a /doc/opal-api | |
| parent | fa2af99dc0e4a9b578d08eafc2b4ac65e8e3f106 (diff) | |
| download | skiboot-98fa85b5022d80849a0acf0b50d7f9a8f96bb942.zip skiboot-98fa85b5022d80849a0acf0b50d7f9a8f96bb942.tar.gz skiboot-98fa85b5022d80849a0acf0b50d7f9a8f96bb942.tar.bz2 | |
doc/opal-api: fix some formatting in OPAL_CONSOLE read/write
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Diffstat (limited to 'doc/opal-api')
| -rw-r--r-- | doc/opal-api/opal-console-read-write-1-2.rst | 6 |
1 files 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 --- a/doc/opal-api/opal-console-read-write-1-2.rst +++ b/doc/opal-api/opal-console-read-write-1-2.rst @@ -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_SUCCESS 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. |