summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJeff Scheel <scheel@us.ibm.com>2017-05-01 13:24:25 -0500
committerStewart Smith <stewart@linux.vnet.ibm.com>2017-05-02 07:52:42 +1000
commit5850a308f354c82488df844cc162c5417f7717d5 (patch)
tree4d3b380c5bf23cddd659276ae21ae02df296b8d2
parent28699cf02b1812a8e8dcf018e8e799a404eff205 (diff)
downloadtalos-skiboot-5850a308f354c82488df844cc162c5417f7717d5.tar.gz
talos-skiboot-5850a308f354c82488df844cc162c5417f7717d5.zip
Documentation minor updates prior to OpenPOWER Foundation PDF generation.
Signed-off-by: Jeff Scheel <scheel@us.ibm.com> [stewart@linux.vnet.ibm.com: fix TODO item, capitalization] Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
-rw-r--r--doc/device-tree/ibm,opal.rst4
-rw-r--r--doc/error-logging.rst2
-rw-r--r--doc/index.rst18
-rw-r--r--doc/stb.rst6
4 files changed, 19 insertions, 11 deletions
diff --git a/doc/device-tree/ibm,opal.rst b/doc/device-tree/ibm,opal.rst
index 2d5782df..149050cb 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 62fbeda2..5367ac22 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 1826d13e..5464ae25 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 b9b13017..2004af87 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::
OpenPOWER on IntegriCloud