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/task_manager.rst | 63 ++++++++++++++++++++++++++++++++----------------- 1 file changed, 42 insertions(+), 21 deletions(-) (limited to 'c-user/task_manager.rst') diff --git a/c-user/task_manager.rst b/c-user/task_manager.rst index 8934315..8917fba 100644 --- a/c-user/task_manager.rst +++ b/c-user/task_manager.rst @@ -598,10 +598,11 @@ related constants, usage, and status codes. \clearpage -.. _rtems_task_create: .. index:: create a task .. index:: rtems_task_create +.. _rtems_task_create: + TASK_CREATE - Create a task --------------------------- @@ -743,10 +744,11 @@ NOTES: \clearpage -.. _rtems_task_ident: .. index:: get ID of a task .. index:: rtems_task_ident +.. _rtems_task_ident: + TASK_IDENT - Get ID of a task ----------------------------- @@ -797,10 +799,11 @@ NOTES: \clearpage -.. _rtems_task_self: .. index:: obtain ID of caller .. index:: rtems_task_self +.. _rtems_task_self: + TASK_SELF - Obtain ID of caller ------------------------------- @@ -823,10 +826,11 @@ NOTES: \clearpage -.. _rtems_task_start: .. index:: starting a task .. index:: rtems_task_start +.. _rtems_task_start: + TASK_START - Start a task ------------------------- @@ -877,10 +881,11 @@ NOTES: \clearpage -.. _rtems_task_restart: .. index:: restarting a task .. index:: rtems_task_restart +.. _rtems_task_restart: + TASK_RESTART - Restart a task ----------------------------- @@ -939,10 +944,11 @@ NOTES: \clearpage -.. _rtems_task_delete: .. index:: deleting a task .. index:: rtems_task_delete +.. _rtems_task_delete: + TASK_DELETE - Delete a task --------------------------- @@ -995,10 +1001,11 @@ NOTES: \clearpage -.. _rtems_task_suspend: .. index:: suspending a task .. index:: rtems_task_suspend +.. _rtems_task_suspend: + TASK_SUSPEND - Suspend a task ----------------------------- @@ -1042,10 +1049,11 @@ NOTES: \clearpage -.. _rtems_task_resume: .. index:: resuming a task .. index:: rtems_task_resume +.. _rtems_task_resume: + TASK_RESUME - Resume a task --------------------------- @@ -1087,10 +1095,11 @@ NOTES: \clearpage -.. _rtems_task_is_suspended: .. index:: is task suspended .. index:: rtems_task_is_suspended +.. _rtems_task_is_suspended: + TASK_IS_SUSPENDED - Determine if a task is Suspended ---------------------------------------------------- @@ -1125,13 +1134,14 @@ NOTES: \clearpage -.. _rtems_task_set_priority: .. index:: rtems_task_set_priority .. index:: current task priority .. index:: set task priority .. index:: get task priority .. index:: obtain task priority +.. _rtems_task_set_priority: + TASK_SET_PRIORITY - Set task priority ------------------------------------- @@ -1189,12 +1199,13 @@ NOTES: \clearpage -.. _rtems_task_get_priority: .. index:: rtems_task_get_priority .. index:: current task priority .. index:: get task priority .. index:: obtain task priority +.. _rtems_task_get_priority: + TASK_GET_PRIORITY - Get task priority ------------------------------------- @@ -1238,7 +1249,6 @@ NOTES: \clearpage -.. _rtems_task_mode: .. index:: current task mode .. index:: set task mode .. index:: get task mode @@ -1247,6 +1257,8 @@ NOTES: .. index:: obtain task mode .. index:: rtems_task_mode +.. _rtems_task_mode: + TASK_MODE - Change the current task mode ---------------------------------------- @@ -1317,11 +1329,12 @@ NOTES: \clearpage -.. _rtems_task_wake_after: .. index:: delay a task for an interval .. index:: wake up after an interval .. index:: rtems_task_wake_after +.. _rtems_task_wake_after: + TASK_WAKE_AFTER - Wake up after interval ---------------------------------------- @@ -1360,11 +1373,12 @@ NOTES: \clearpage -.. _rtems_task_wake_when: .. index:: delay a task until a wall time .. index:: wake up at a wall time .. index:: rtems_task_wake_when +.. _rtems_task_wake_when: + TASK_WAKE_WHEN - Wake up when specified --------------------------------------- @@ -1616,10 +1630,11 @@ NOTES: \clearpage -.. _rtems_task_iterate: .. index:: iterate over all threads .. index:: rtems_task_iterate +.. _rtems_task_iterate: + TASK_ITERATE - Iterate Over Tasks --------------------------------- @@ -1658,9 +1673,10 @@ Deprecated and Removed Directives \clearpage -.. _rtems_iterate_over_all_threads: .. index:: rtems_iterate_over_all_threads +.. _rtems_iterate_over_all_threads: + ITERATE_OVER_ALL_THREADS - Iterate Over Tasks --------------------------------------------- @@ -1697,10 +1713,11 @@ NOTES: \clearpage -.. _rtems_task_get_note: .. index:: get task notepad entry .. index:: rtems_task_get_note +.. _rtems_task_get_note: + TASK_GET_NOTE - Get task notepad entry -------------------------------------- @@ -1750,10 +1767,11 @@ NOTES: \clearpage -.. _rtems_task_set_note: .. index:: set task notepad entry .. index:: rtems_task_set_note +.. _rtems_task_set_note: + TASK_SET_NOTE - Set task notepad entry -------------------------------------- @@ -1802,12 +1820,13 @@ NOTES: \clearpage -.. _rtems_task_variable_add: .. index:: per-task variable .. index:: task private variable .. index:: task private data .. index:: rtems_task_variable_add +.. _rtems_task_variable_add: + TASK_VARIABLE_ADD - Associate per task variable ----------------------------------------------- @@ -1865,11 +1884,12 @@ NOTES: \clearpage -.. _rtems_task_variable_get: .. index:: get per-task variable .. index:: obtain per-task variable .. index:: rtems_task_variable_get +.. _rtems_task_variable_get: + TASK_VARIABLE_GET - Obtain value of a per task variable ------------------------------------------------------- @@ -1922,12 +1942,13 @@ NOTES: \clearpage -.. _rtems_task_variable_delete: .. index:: per-task variable .. index:: task private variable .. index:: task private data .. index:: rtems_task_variable_delete +.. _rtems_task_variable_delete: + TASK_VARIABLE_DELETE - Remove per task variable ----------------------------------------------- -- cgit v1.2.3