[Skiboot] [PATCH] Documentation minor updates prior to OpenPOWER Foundation PDF generation.

Stewart Smith stewart at linux.vnet.ibm.com
Tue May 2 07:53:59 AEST 2017


From: Jeff Scheel <scheel at us.ibm.com>

Signed-off-by: Jeff Scheel <scheel at us.ibm.com>
[stewart at linux.vnet.ibm.com: fix TODO item, capitalization]
Signed-off-by: Stewart Smith <stewart at linux.vnet.ibm.com>
---
 doc/device-tree/ibm,opal.rst |  4 ++++
 doc/error-logging.rst        |  2 +-
 doc/index.rst                | 18 +++++++++++-------
 doc/stb.rst                  |  6 +++---
 4 files changed, 19 insertions(+), 11 deletions(-)

diff --git a/doc/device-tree/ibm,opal.rst b/doc/device-tree/ibm,opal.rst
index 2d5782df0fd6..149050cb9a02 100644
--- a/doc/device-tree/ibm,opal.rst
+++ b/doc/device-tree/ibm,opal.rst
@@ -10,6 +10,9 @@ ibm,opal
    ibm,opal/*
 
 
+Top level ibm,opal node
+-----------------------
+
 .. code-block:: dts
 
    ibm,opal {
@@ -46,3 +49,4 @@ ibm,opal
 		opal-msg-size = <0x48>;
 		opal-runtime-size = <0x0 0x9a00000>;
 		phandle = <0x10000003>;
+    };
diff --git a/doc/error-logging.rst b/doc/error-logging.rst
index 62fbeda2d562..5367ac22b684 100644
--- a/doc/error-logging.rst
+++ b/doc/error-logging.rst
@@ -285,7 +285,7 @@ OPAL maintains below lists:
 * Free list      : List of free nodes.
 * Pending list   : List of nodes which is yet to be read by the POWERNV.
 * Processed list : List of nodes which has been read but still waiting for
-			acknowledgement.
+  acknowledgement.
 
 Below is the structure of the node: ::
 
diff --git a/doc/index.rst b/doc/index.rst
index 1826d13e5bc1..5464ae252384 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -3,11 +3,13 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+=====================
+SkiBoot Documentation
+=====================
+
 Overview
 ========
 
-Contents:
-
 .. toctree::
    :maxdepth: 2
 
@@ -53,10 +55,12 @@ skiboot Release Notes
 
    release-notes/index
 
-Indices and tables
-==================
+.. only:: latex
+
+    Indices and tables
+    ==================
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+    * :ref:`genindex`
+    * :ref:`modindex`
+    * :ref:`search`
 
diff --git a/doc/stb.rst b/doc/stb.rst
index b9b13017443b..2004af876f2f 100644
--- a/doc/stb.rst
+++ b/doc/stb.rst
@@ -1,8 +1,8 @@
 .. _stb-overview:
 
-===============================
-Secure and Truted Boot Overview
-===============================
+================================
+Secure and Trusted Boot Overview
+================================
 
 Just as a quick reference::
 
-- 
2.9.3



More information about the Skiboot mailing list