[Skiboot] [PATCH 030/110] doc: combine OPAL_RTC_READ and OPAL_RTC_WRITE pages

Stewart Smith stewart at linux.ibm.com
Fri May 31 16:12:31 AEST 2019


One page for Real Time Clock is a bit clearer.

Signed-off-by: Stewart Smith <stewart at linux.ibm.com>
---
 ...tc-read-3.rst => opal-rtc-read-write-3-4.rst} | 16 ++++++++++++++++
 doc/opal-api/opal-rtc-write-4.rst                | 11 -----------
 2 files changed, 16 insertions(+), 11 deletions(-)
 rename doc/opal-api/{opal-rtc-read-3.rst => opal-rtc-read-write-3-4.rst} (83%)
 delete mode 100644 doc/opal-api/opal-rtc-write-4.rst

diff --git a/doc/opal-api/opal-rtc-read-3.rst b/doc/opal-api/opal-rtc-read-write-3-4.rst
similarity index 83%
rename from doc/opal-api/opal-rtc-read-3.rst
rename to doc/opal-api/opal-rtc-read-write-3-4.rst
index e2d492f2e0bf..e324e1a3c667 100644
--- a/doc/opal-api/opal-rtc-read-3.rst
+++ b/doc/opal-api/opal-rtc-read-write-3-4.rst
@@ -1,3 +1,7 @@
+===============================
+OPAL Real Time Clock (RTC) APIs
+===============================
+
 .. _OPAL_RTC_READ:
 
 OPAL_RTC_READ
@@ -73,3 +77,15 @@ Return codes
 
 :ref:`OPAL_BUSY`
   request may be in flight
+
+.. _OPAL_RTC_WRITE:
+
+OPAL_RTC_WRITE
+==============
+
+:ref:`OPAL_RTC_WRITE` is much like :ref:`OPAL_RTC_READ` in that it can be asynchronous.
+
+If multiple WRITES are issued before the first one completes, subsequent
+writes are ignored. There can only be one write in flight at any one time.
+
+Format of the time is the same as for :ref:`OPAL_RTC_READ`.
diff --git a/doc/opal-api/opal-rtc-write-4.rst b/doc/opal-api/opal-rtc-write-4.rst
deleted file mode 100644
index c5ef7503bef7..000000000000
--- a/doc/opal-api/opal-rtc-write-4.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-.. _OPAL_RTC_WRITE:
-
-OPAL_RTC_WRITE
-==============
-
-:ref:`OPAL_RTC_WRITE` is much like :ref:`OPAL_RTC_READ` in that it can be asynchronous.
-
-If multiple WRITES are issued before the first one completes, subsequent
-writes are ignored. There can only be one write in flight at any one time.
-
-Format of the time is the same as for :ref:`OPAL_RTC_READ`.
-- 
2.21.0



More information about the Skiboot mailing list