summaryrefslogtreecommitdiffstats
path: root/c-user/task/introduction.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-01-15 14:08:35 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-04-28 09:03:49 +0200
commit2ae3364b107942b0b5b41aa57f41c8c6b76a601c (patch)
tree6338de2ebee63171a844fb4a2de77e94422a4766 /c-user/task/introduction.rst
parentc-user: Fix typo "cod" -> "code" (diff)
downloadrtems-docs-2ae3364b107942b0b5b41aa57f41c8c6b76a601c.tar.bz2
c-user: Generate task manager documentation
The documentation is a consolidation of the comments in Doxygen markup and the documentation sources in Sphinx markup. The documentation was transfered to interface specification items. The documentation source files were generated from the items by a script. Update #3993.
Diffstat (limited to '')
-rw-r--r--c-user/task/introduction.rst104
1 files changed, 80 insertions, 24 deletions
diff --git a/c-user/task/introduction.rst b/c-user/task/introduction.rst
index 449b335..5d6eba4 100644
--- a/c-user/task/introduction.rst
+++ b/c-user/task/introduction.rst
@@ -1,50 +1,106 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 1988, 2017 On-Line Applications Research Corporation (OAR)
+
+.. This file is part of the RTEMS quality process and was automatically
+.. generated. If you find something that needs to be fixed or
+.. worded better please post a report or patch to an RTEMS mailing list
+.. or raise a bug report:
+..
+.. https://www.rtems.org/bugs.html
+..
+.. For information on updating and regenerating please refer to the How-To
+.. section in the Software Requirements Engineering chapter of the
+.. RTEMS Software Engineering manual. The manual is provided as a part of
+.. a release. For development sources please refer to the online
+.. documentation at:
+..
+.. https://docs.rtems.org
+
+.. Generated from spec:/rtems/task/if/group
+
+.. _TaskManagerIntroduction:
Introduction
============
-The task manager provides a comprehensive set of directives to create, delete,
-and administer tasks. The directives provided by the task manager are:
+.. The following list was generated from:
+.. spec:/rtems/task/if/create
+.. spec:/rtems/task/if/construct
+.. spec:/rtems/task/if/ident
+.. spec:/rtems/task/if/self
+.. spec:/rtems/task/if/start
+.. spec:/rtems/task/if/restart
+.. spec:/rtems/task/if/delete
+.. spec:/rtems/task/if/exit
+.. spec:/rtems/task/if/suspend
+.. spec:/rtems/task/if/resume
+.. spec:/rtems/task/if/is-suspended
+.. spec:/rtems/task/if/set-priority
+.. spec:/rtems/task/if/get-priority
+.. spec:/rtems/task/if/mode
+.. spec:/rtems/task/if/wake-after
+.. spec:/rtems/task/if/wake-when
+.. spec:/rtems/task/if/get-scheduler
+.. spec:/rtems/task/if/set-scheduler
+.. spec:/rtems/task/if/get-affinity
+.. spec:/rtems/task/if/set-affinity
+.. spec:/rtems/task/if/iterate
+.. spec:/rtems/task/if/storage-size
-- :ref:`rtems_task_create`
+The Task Manager provides a comprehensive set of directives to create, delete,
+and administer tasks. The directives provided by the Task Manager are:
-- :ref:`rtems_task_ident`
+* :ref:`InterfaceRtemsTaskCreate` - Creates a task.
-- :ref:`rtems_task_self`
+* :ref:`InterfaceRtemsTaskConstruct` - Constructs a task from the specified
+ task configuration.
-- :ref:`rtems_task_start`
+* :ref:`InterfaceRtemsTaskIdent` - Identifies a task by the object name.
-- :ref:`rtems_task_restart`
+* :ref:`InterfaceRtemsTaskSelf` - Gets the task identifier of the calling task.
-- :ref:`rtems_task_delete`
+* :ref:`InterfaceRtemsTaskStart` - Starts the task.
-- :ref:`rtems_task_exit`
+* :ref:`InterfaceRtemsTaskRestart` - Restarts the task.
-- :ref:`rtems_task_suspend`
+* :ref:`InterfaceRtemsTaskDelete` - Deletes the task.
-- :ref:`rtems_task_resume`
+* :ref:`InterfaceRtemsTaskExit` - Deletes the calling task.
-- :ref:`rtems_task_is_suspended`
+* :ref:`InterfaceRtemsTaskSuspend` - Suspends the task.
-- :ref:`rtems_task_set_priority`
+* :ref:`InterfaceRtemsTaskResume` - Resumes the task.
-- :ref:`rtems_task_get_priority`
+* :ref:`InterfaceRtemsTaskIsSuspended` - Checks if the task is suspended.
-- :ref:`rtems_task_mode`
+* :ref:`InterfaceRtemsTaskSetPriority` - Sets the real priority or gets the
+ current priority of the task.
-- :ref:`rtems_task_wake_after`
+* :ref:`InterfaceRtemsTaskGetPriority` - Gets the current priority of the task
+ with respect to the scheduler.
-- :ref:`rtems_task_wake_when`
+* :ref:`InterfaceRtemsTaskMode` - Gets and optionally sets the mode of the
+ calling task.
-- :ref:`rtems_task_get_scheduler`
+* :ref:`InterfaceRtemsTaskWakeAfter` - Wakes up after an interval in
+ :term:`clock ticks <clock tick>` or yields the processor.
-- :ref:`rtems_task_set_scheduler`
+* :ref:`InterfaceRtemsTaskWakeWhen` - Wakes up when specified.
-- :ref:`rtems_task_get_affinity`
+* :ref:`InterfaceRtemsTaskGetScheduler` - Gets the home scheduler of the task.
-- :ref:`rtems_task_set_affinity`
+* :ref:`InterfaceRtemsTaskSetScheduler` - Sets the home scheduler for the task.
-- :ref:`rtems_task_iterate`
+* :ref:`InterfaceRtemsTaskGetAffinity` - Gets the processor affinity of the
+ task.
+
+* :ref:`InterfaceRtemsTaskSetAffinity` - Sets the processor affinity of the
+ task.
+
+* :ref:`InterfaceRtemsTaskIterate` - Iterates over all tasks and invokes the
+ visitor routine for each task.
+
+* :ref:`InterfaceRTEMSTASKSTORAGESIZE` - Gets the recommended task storage area
+ size for the size and task attributes.