From 33849946ff6022c26722ec71248fd76aa55de4ef Mon Sep 17 00:00:00 2001 From: Chris Johns Date: Mon, 13 Nov 2017 13:25:18 +1100 Subject: 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. --- c-user/rate_monotonic_manager.rst | 41 +++++++++++++++++++++++++-------------- 1 file changed, 26 insertions(+), 15 deletions(-) (limited to 'c-user/rate_monotonic_manager.rst') diff --git a/c-user/rate_monotonic_manager.rst b/c-user/rate_monotonic_manager.rst index ad675b0..eeb1ec6 100644 --- a/c-user/rate_monotonic_manager.rst +++ b/c-user/rate_monotonic_manager.rst @@ -634,10 +634,11 @@ sequence, related constants, usage, and status codes. \clearpage -.. _rtems_rate_monotonic_create: .. index:: create a period .. index:: rtems_rate_monotonic_create +.. _rtems_rate_monotonic_create: + RATE_MONOTONIC_CREATE - Create a rate monotonic period ------------------------------------------------------ @@ -674,11 +675,12 @@ NOTES: \clearpage -.. _rtems_rate_monotonic_ident: .. index:: get ID of a period .. index:: obtain ID of a period .. index:: rtems_rate_monotonic_ident +.. _rtems_rate_monotonic_ident: + RATE_MONOTONIC_IDENT - Get ID of a period ----------------------------------------- @@ -713,10 +715,11 @@ NOTES: \clearpage -.. _rtems_rate_monotonic_cancel: .. index:: cancel a period .. index:: rtems_rate_monotonic_cancel +.. _rtems_rate_monotonic_cancel: + RATE_MONOTONIC_CANCEL - Cancel a period --------------------------------------- @@ -754,10 +757,11 @@ NOTES: \clearpage -.. _rtems_rate_monotonic_delete: .. index:: rtems_rate_monotonic_delete .. index:: delete a period +.. _rtems_rate_monotonic_delete: + RATE_MONOTONIC_DELETE - Delete a rate monotonic period ------------------------------------------------------ @@ -793,12 +797,13 @@ NOTES: \clearpage -.. _rtems_rate_monotonic_period: .. index:: conclude current period .. index:: start current period .. index:: period initiation .. index:: rtems_rate_monotonic_period +.. _rtems_rate_monotonic_period: + RATE_MONOTONIC_PERIOD - Conclude current/Start next period ---------------------------------------------------------- @@ -847,11 +852,12 @@ NOTES: \clearpage -.. _rtems_rate_monotonic_get_status: .. index:: get status of period .. index:: obtain status of period .. index:: rtems_rate_monotonic_get_status +.. _rtems_rate_monotonic_get_status: + RATE_MONOTONIC_GET_STATUS - Obtain status from a period ------------------------------------------------------- @@ -898,12 +904,13 @@ DIRECTIVE STATUS CODES: time values will be set to 0. Otherwise, both time values will contain time information since the last invocation of the ``rtems_rate_monotonic_period`` directive. More specifically, the - since_last_period value contains the elapsed time which has occurred - since the last invocation of the ``rtems_rate_monotonic_period`` directive - and the ``executed_since_last_period`` contains how much processor - time the owning task has consumed since the invocation of the + since_last_period value contains the elapsed time which has occurred since + the last invocation of the ``rtems_rate_monotonic_period`` directive and + the ``executed_since_last_period`` contains how much processor time the + owning task has consumed since the invocation of the ``rtems_rate_monotonic_period`` directive. In addition, the - postponed_jobs_count value contains the count of jobs which are not released yet. + ``postponed_jobs_count value`` contains the count of jobs which are not + released yet. NOTES: This directive will not cause the running task to be preempted. @@ -912,11 +919,12 @@ NOTES: \clearpage -.. _rtems_rate_monotonic_get_statistics: .. index:: get statistics of period .. index:: obtain statistics of period .. index:: rtems_rate_monotonic_get_statistics +.. _rtems_rate_monotonic_get_statistics: + RATE_MONOTONIC_GET_STATISTICS - Obtain statistics from a period --------------------------------------------------------------- @@ -981,10 +989,11 @@ NOTES: \clearpage -.. _rtems_rate_monotonic_reset_statistics: .. index:: reset statistics of period .. index:: rtems_rate_monotonic_reset_statistics +.. _rtems_rate_monotonic_reset_statistics: + RATE_MONOTONIC_RESET_STATISTICS - Reset statistics for a period --------------------------------------------------------------- @@ -1015,10 +1024,11 @@ NOTES: \clearpage -.. _rtems_rate_monotonic_reset_all_statistics: .. index:: reset statistics of all periods .. index:: rtems_rate_monotonic_reset_all_statistics +.. _rtems_rate_monotonic_reset_all_statistics: + RATE_MONOTONIC_RESET_ALL_STATISTICS - Reset statistics for all periods ---------------------------------------------------------------------- @@ -1041,11 +1051,12 @@ NOTES: \clearpage -.. _rtems_rate_monotonic_report_statistics: .. index:: print period statistics report .. index:: period statistics report .. index:: rtems_rate_monotonic_report_statistics +.. _rtems_rate_monotonic_report_statistics: + RATE_MONOTONIC_REPORT_STATISTICS - Print period statistics report ----------------------------------------------------------------- -- cgit v1.2.3