summaryrefslogtreecommitdiffstats
path: root/c-user/timer_manager.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-11-13 13:25:18 +1100
committerChris Johns <chrisj@rtems.org>2017-11-13 13:25:18 +1100
commit33849946ff6022c26722ec71248fd76aa55de4ef (patch)
treef082f683008e92f0894d8ac36bc4c83d4860bd37 /c-user/timer_manager.rst
parentac0eaff94117757046867bc92797d6c2dae78cd4 (diff)
downloadrtems-docs-33849946ff6022c26722ec71248fd76aa55de4ef.tar.bz2
Clean up sphinx warnings.
- Fix minor formatting issues. - Fix reference the gloassary TLS using ':term:'. - Make sure nothing is between an anchor and the heading where ':ref:' references the anchor. This meant moving all the recently added '.. index::' entries. Update #3232. Update #3229.
Diffstat (limited to 'c-user/timer_manager.rst')
-rw-r--r--c-user/timer_manager.rst30
1 files changed, 20 insertions, 10 deletions
diff --git a/c-user/timer_manager.rst b/c-user/timer_manager.rst
index ca80dfd..8e41b47 100644
--- a/c-user/timer_manager.rst
+++ b/c-user/timer_manager.rst
@@ -194,10 +194,11 @@ related constants, usage, and status codes.
.. raw:: latex
\clearpage
-.. _rtems_timer_create:
.. index:: create a timer
.. index:: rtems_timer_create
+.. _rtems_timer_create:
+
TIMER_CREATE - Create a timer
-----------------------------
@@ -240,10 +241,11 @@ NOTES:
\clearpage
-.. _rtems_timer_ident:
.. index:: obtain the ID of a timer
.. index:: rtems_timer_ident
+.. _rtems_timer_ident:
+
TIMER_IDENT - Get ID of a timer
-------------------------------
@@ -280,10 +282,11 @@ NOTES:
\clearpage
-.. _rtems_timer_cancel:
.. index:: cancel a timer
.. index:: rtems_timer_cancel
+.. _rtems_timer_cancel:
+
TIMER_CANCEL - Cancel a timer
-----------------------------
@@ -315,10 +318,11 @@ NOTES:
\clearpage
-.. _rtems_timer_delete:
.. index:: delete a timer
.. index:: rtems_timer_delete
+.. _rtems_timer_delete:
+
TIMER_DELETE - Delete a timer
-----------------------------
@@ -354,10 +358,11 @@ NOTES:
\clearpage
-.. _rtems_timer_fire_after:
.. index:: fire a timer after an interval
.. index:: rtems_timer_fire_after
+.. _rtems_timer_fire_after:
+
TIMER_FIRE_AFTER - Fire timer after interval
--------------------------------------------
@@ -398,10 +403,11 @@ NOTES:
\clearpage
-.. _rtems_timer_fire_when:
.. index:: fire a timer at wall time
.. index:: rtems_timer_fire_when
+.. _rtems_timer_fire_when:
+
TIMER_FIRE_WHEN - Fire timer when specified
-------------------------------------------
@@ -446,10 +452,11 @@ NOTES:
\clearpage
-.. _rtems_timer_initiate_server:
.. index:: initiate the Timer Server
.. index:: rtems_timer_initiate_server
+.. _rtems_timer_initiate_server:
+
TIMER_INITIATE_SERVER - Initiate server for task-based timers
-------------------------------------------------------------
@@ -491,10 +498,11 @@ NOTES:
\clearpage
-.. _rtems_timer_server_fire_after:
.. index:: fire task-based a timer after an interval
.. index:: rtems_timer_server_fire_after
+.. _rtems_timer_server_fire_after:
+
TIMER_SERVER_FIRE_AFTER - Fire task-based timer after interval
--------------------------------------------------------------
@@ -539,10 +547,11 @@ NOTES:
\clearpage
-.. _rtems_timer_server_fire_when:
.. index:: fire a task-based timer at wall time
.. index:: rtems_timer_server_fire_when
+.. _rtems_timer_server_fire_when:
+
TIMER_SERVER_FIRE_WHEN - Fire task-based timer when specified
-------------------------------------------------------------
@@ -591,10 +600,11 @@ NOTES:
\clearpage
-.. _rtems_timer_reset:
.. index:: reset a timer
.. index:: rtems_timer_reset
+.. _rtems_timer_reset:
+
TIMER_RESET - Reset an interval timer
-------------------------------------