[Skiboot] [PATCH V4 4/4] doc/opal-api : Corrects typo errors and adheres to sphinx documentation

Mukesh Ojha mukesh02 at linux.vnet.ibm.com
Sun Aug 7 23:33:25 AEST 2016


Other changes related to sphinx documentation.

Signed-off-by: Mukesh Ojha <mukesh02 at linux.vnet.ibm.com>
Changes in V4:
 - New patch.

 doc/opal-api/opal-console-read-write-1-2.rst |  2 +-
 doc/opal-api/opal-flash-110-111-112.rst      | 11 ++++++-----
 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.
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:
   operation started, an async completion will be triggered with the ``token`` argument
   invalid flash id
   invalid size or offset (alignment, or access beyond end of device)
   flash in use
   error accessing flash device
+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 @@
 The host OS can use OPAL_GET_MSG to retrive messages queued by OPAL. The

More information about the Skiboot mailing list