From 5850a308f354c82488df844cc162c5417f7717d5 Mon Sep 17 00:00:00 2001 From: Jeff Scheel Date: Mon, 1 May 2017 13:24:25 -0500 Subject: Documentation minor updates prior to OpenPOWER Foundation PDF generation. Signed-off-by: Jeff Scheel [stewart@linux.vnet.ibm.com: fix TODO item, capitalization] Signed-off-by: Stewart Smith --- 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(-) (limited to 'doc') diff --git a/doc/device-tree/ibm,opal.rst b/doc/device-tree/ibm,opal.rst index 2d5782d..149050c 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 62fbeda..5367ac2 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 1826d13..5464ae2 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 b9b1301..2004af8 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:: -- cgit v1.1