diff options
| author | Mukesh Ojha <mukesh02@linux.vnet.ibm.com> | 2016-08-07 19:03:25 +0530 |
|---|---|---|
| committer | Stewart Smith <stewart@linux.vnet.ibm.com> | 2016-08-09 17:34:12 +1000 |
| commit | fa2af99dc0e4a9b578d08eafc2b4ac65e8e3f106 (patch) | |
| tree | b0b338a7f625f32074612dc1370eaeb279bcc5a1 /doc | |
| parent | 9a137af05f1d7378d1404bb9633dfb92d3f93f7e (diff) | |
| download | skiboot-fa2af99dc0e4a9b578d08eafc2b4ac65e8e3f106.zip skiboot-fa2af99dc0e4a9b578d08eafc2b4ac65e8e3f106.tar.gz skiboot-fa2af99dc0e4a9b578d08eafc2b4ac65e8e3f106.tar.bz2 | |
doc/opal-api : Corrects typo errors and adheres to sphinx documentation
OAPL->OPAL
conformining->conforming
Other changes related to sphinx documentation.
Signed-off-by: Mukesh Ojha <mukesh02@linux.vnet.ibm.com>
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/opal-api/opal-console-read-write-1-2.rst | 2 | ||||
| -rw-r--r-- | doc/opal-api/opal-flash-110-111-112.rst | 11 | ||||
| -rw-r--r-- | doc/opal-api/opal-messages.rst | 2 |
3 files changed, 8 insertions, 7 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 43b5f9d..73832dc 100644 --- a/doc/opal-api/opal-console-read-write-1-2.rst +++ b/doc/opal-api/opal-console-read-write-1-2.rst @@ -35,7 +35,7 @@ Returns: :: term_number is the terminal number as represented in the device tree. length is a pointer to the length of buffer. -A conformining implementation SHOULD try to NOT do partial writes, although +A conforming implementation SHOULD try to NOT do partial writes, although partial writes and not writing anything are valid. OPAL_CONSOLE_WRITE_BUFFER_SPACE diff --git a/doc/opal-api/opal-flash-110-111-112.rst b/doc/opal-api/opal-flash-110-111-112.rst index 51bdb6c..0bd8180 100644 --- a/doc/opal-api/opal-flash-110-111-112.rst +++ b/doc/opal-api/opal-flash-110-111-112.rst @@ -25,22 +25,23 @@ All calls share the same return values: ``OPAL_ASYNC_COMPLETION`` operation started, an async completion will be triggered with the ``token`` argument -OPAL_PARAMETER +``OPAL_PARAMETER`` invalid flash id -OPAL_PARAMETER +``OPAL_PARAMETER`` invalid size or offset (alignment, or access beyond end of device) -OPAL_BUSY +``OPAL_BUSY`` flash in use -OPAL_HARDWARE +``OPAL_HARDWARE`` error accessing flash device OPAL_FLASH_READ --------------- -Parameters: +Parameters: :: + uint64_t id uint64_t offset uint64_t buffer diff --git a/doc/opal-api/opal-messages.rst b/doc/opal-api/opal-messages.rst index ceddb69..dfb74e4 100644 --- a/doc/opal-api/opal-messages.rst +++ b/doc/opal-api/opal-messages.rst @@ -1,4 +1,4 @@ -OAPL_MESSAGE +OPAL_MESSAGE ============ The host OS can use OPAL_GET_MSG to retrive messages queued by OPAL. The |