summaryrefslogtreecommitdiffstats
path: root/doc/opal-api
diff options
context:
space:
mode:
authorStewart Smith <stewart@linux.vnet.ibm.com>2016-10-28 11:49:24 +1100
committerStewart Smith <stewart@linux.vnet.ibm.com>2016-10-28 16:41:08 +1100
commit0560492933ef232d0f5eed9885fd9490453ef548 (patch)
treeed04bf5288916a4fdbddc43ef74e639a06e34d66 /doc/opal-api
parente6099da0f0718cfbf5a6d8e89923d134008bf8b7 (diff)
downloadtalos-skiboot-0560492933ef232d0f5eed9885fd9490453ef548.tar.gz
talos-skiboot-0560492933ef232d0f5eed9885fd9490453ef548.zip
doc: use RST references where appropriate
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Diffstat (limited to 'doc/opal-api')
-rw-r--r--doc/opal-api/opal-flash-110-111-112.rst2
-rw-r--r--doc/opal-api/opal-get-msg-85.rst3
-rw-r--r--doc/opal-api/opal-handle-interrupt.rst2
-rw-r--r--doc/opal-api/opal-led-get-set-114-115.rst3
-rw-r--r--doc/opal-api/opal-messages.rst2
-rw-r--r--doc/opal-api/opal-poll-events.rst2
6 files changed, 10 insertions, 4 deletions
diff --git a/doc/opal-api/opal-flash-110-111-112.rst b/doc/opal-api/opal-flash-110-111-112.rst
index c58eefdf..71ba866d 100644
--- a/doc/opal-api/opal-flash-110-111-112.rst
+++ b/doc/opal-api/opal-flash-110-111-112.rst
@@ -9,7 +9,7 @@ There are three OPAL calls for interacting with flash devices: ::
Multiple flash devices are supported by OPAL - each of these calls takes an id
parameter, which much match an ID found in the corresponding ``ibm,opal/flash@n``
-device tree node. See doc/device-tree/ibm,opal/flash.rst for details of
+device tree node. See :ref:`device-tree/ibm,opal/flash` for details of
the device tree bindings.
All operations on the flash device must be aligned to the block size of the
diff --git a/doc/opal-api/opal-get-msg-85.rst b/doc/opal-api/opal-get-msg-85.rst
index 7e65b417..2cc9307e 100644
--- a/doc/opal-api/opal-get-msg-85.rst
+++ b/doc/opal-api/opal-get-msg-85.rst
@@ -1,8 +1,7 @@
OPAL_GET_MSG
============
-OPAL_GET_MSG will get the next pending OPAL Message (see
-doc/opal-api/opal-messages.rst).
+OPAL_GET_MSG will get the next pending OPAL Message (see :ref:`opal-messages`).
Parameters: ::
diff --git a/doc/opal-api/opal-handle-interrupt.rst b/doc/opal-api/opal-handle-interrupt.rst
index 42b26e9e..ce2028fc 100644
--- a/doc/opal-api/opal-handle-interrupt.rst
+++ b/doc/opal-api/opal-handle-interrupt.rst
@@ -24,4 +24,4 @@ The ``OPAL_HANDLE_INTERRUPT`` call takes two parameters, one input and one outpu
The host OS should then handle any outstanding events.
-See doc/opal-api/opal-poll-events.rst for documentation on events.
+See :ref:`OPAL_POLL_EVENTS` for documentation on events.
diff --git a/doc/opal-api/opal-led-get-set-114-115.rst b/doc/opal-api/opal-led-get-set-114-115.rst
index 85656bf1..c0d874ea 100644
--- a/doc/opal-api/opal-led-get-set-114-115.rst
+++ b/doc/opal-api/opal-led-get-set-114-115.rst
@@ -1,3 +1,5 @@
+.. _opal-api-LEDs:
+
Service Indicators (LEDS)
=========================
@@ -19,6 +21,7 @@ Different types of indicators handled by LED code:
Indicates there is a problem with the FRU or resource at the
location with which the indicator is associated.
+All LEDs are defined in the device tree (see :ref:`device-tree/ibm,opal/leds`).
LED Design
----------
diff --git a/doc/opal-api/opal-messages.rst b/doc/opal-api/opal-messages.rst
index dfb74e4c..e4e813aa 100644
--- a/doc/opal-api/opal-messages.rst
+++ b/doc/opal-api/opal-messages.rst
@@ -1,3 +1,5 @@
+.. _opal-messages:
+
OPAL_MESSAGE
============
diff --git a/doc/opal-api/opal-poll-events.rst b/doc/opal-api/opal-poll-events.rst
index c70d7f0f..71ca21bf 100644
--- a/doc/opal-api/opal-poll-events.rst
+++ b/doc/opal-api/opal-poll-events.rst
@@ -1,3 +1,5 @@
+.. _OPAL_POLL_EVENTS:
+
OPAL_POLL_EVENTS
================
OpenPOWER on IntegriCloud