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/timespec_helpers.rst | 42 ++++++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 14 deletions(-) (limited to 'c-user/timespec_helpers.rst') diff --git a/c-user/timespec_helpers.rst b/c-user/timespec_helpers.rst index 115833b..e169809 100644 --- a/c-user/timespec_helpers.rst +++ b/c-user/timespec_helpers.rst @@ -125,10 +125,11 @@ sequence, related constants, usage, and status codes. \clearpage -.. _rtems_timespec_set: .. index:: set struct timespec instance .. index:: rtems_timespec_set +.. _rtems_timespec_set: + TIMESPEC_SET - Set struct timespec Instance ------------------------------------------- @@ -156,9 +157,10 @@ NOTES: \clearpage -.. _rtems_timespec_zero: .. index:: rtems_timespec_zero +.. _rtems_timespec_zero: + TIMESPEC_ZERO - Zero struct timespec Instance --------------------------------------------- @@ -183,9 +185,10 @@ NOTES: \clearpage -.. _rtems_timespec_is_valid: .. index:: rtems_timespec_is_valid +.. _rtems_timespec_is_valid: + TIMESPEC_IS_VALID - Check validity of a struct timespec instance ---------------------------------------------------------------- @@ -212,9 +215,10 @@ NOTES: \clearpage -.. _rtems_timespec_add_to: .. index:: rtems_timespec_add_to +.. _rtems_timespec_add_to: + TIMESPEC_ADD_TO - Add Two struct timespec Instances --------------------------------------------------- @@ -241,9 +245,10 @@ NOTES: \clearpage -.. _rtems_timespec_subtract: .. index:: rtems_timespec_subtract +.. _rtems_timespec_subtract: + TIMESPEC_SUBTRACT - Subtract Two struct timespec Instances ---------------------------------------------------------- @@ -275,9 +280,10 @@ NOTES: \clearpage -.. _rtems_timespec_divide: .. index:: rtems_timespec_divide +.. _rtems_timespec_divide: + TIMESPEC_DIVIDE - Divide Two struct timespec Instances ------------------------------------------------------ @@ -315,9 +321,10 @@ NOTES: \clearpage -.. _rtems_timespec_divide_by_integer: .. index:: rtems_timespec_divide_by_integer +.. _rtems_timespec_divide_by_integer: + TIMESPEC_DIVIDE_BY_INTEGER - Divide a struct timespec Instance by an Integer ---------------------------------------------------------------------------- @@ -346,9 +353,10 @@ NOTES: \clearpage -.. _rtems_timespec_less_than: .. index:: rtems_timespec_less_than +.. _rtems_timespec_less_than: + TIMESPEC_LESS_THAN - Less than operator --------------------------------------- @@ -376,9 +384,10 @@ NOTES: \clearpage -.. _rtems_timespec_greater_than: .. index:: rtems_timespec_greater_than +.. _rtems_timespec_greater_than: + TIMESPEC_GREATER_THAN - Greater than operator --------------------------------------------- @@ -404,9 +413,10 @@ NOTES: \clearpage -.. _rtems_timespec_equal_to: .. index:: rtems_timespec_equal_to +.. _rtems_timespec_equal_to: + TIMESPEC_EQUAL_TO - Check equality of timespecs ----------------------------------------------- @@ -432,9 +442,10 @@ NOTES: \clearpage -.. _rtems_timespec_get_seconds: .. index:: rtems_timespec_get_seconds +.. _rtems_timespec_get_seconds: + TIMESPEC_GET_SECONDS - Get Seconds Portion of struct timespec Instance ---------------------------------------------------------------------- @@ -460,9 +471,10 @@ NOTES: \clearpage -.. _rtems_timespec_get_nanoseconds: .. index:: rtems_timespec_get_nanoseconds +.. _rtems_timespec_get_nanoseconds: + TIMESPEC_GET_NANOSECONDS - Get Nanoseconds Portion of the struct timespec Instance ---------------------------------------------------------------------------------- @@ -488,9 +500,10 @@ NOTES: \clearpage -.. _rtems_timespec_to_ticks: .. index:: rtems_timespec_to_ticks +.. _rtems_timespec_to_ticks: + TIMESPEC_TO_TICKS - Convert struct timespec Instance to Ticks ------------------------------------------------------------- @@ -515,9 +528,10 @@ NOTES: \clearpage -.. _rtems_timespec_from_ticks: .. index:: rtems_timespec_from_ticks +.. _rtems_timespec_from_ticks: + TIMESPEC_FROM_TICKS - Convert Ticks to struct timespec Representation --------------------------------------------------------------------- -- cgit v1.2.3