[rtems commit] doc: rtems_task_get_scheduler()

[Sebastian Huber]

Module:    rtems
Branch:    master
Commit:    babb1a2ce86f6941107b160478074cd133654132
Changeset: http://git.rtems.org/rtems/commit/?id=babb1a2ce86f6941107b160478074cd133654132

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed Apr 16 16:02:24 2014 +0200

doc: rtems_task_get_scheduler()

---

 doc/user/smp.t |   35 +++++++++++++++++++++++++++++++++++
 1 files changed, 35 insertions(+), 0 deletions(-)

diff --git a/doc/user/smp.t b/doc/user/smp.t
index bd840c1..abdd81c 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -18,6 +18,7 @@ The application level services currently provided are:
 @item @code{rtems_get_current_processor} - Get current processor index
 @item @code{rtems_scheduler_ident} - Get ID of a scheduler
 @item @code{rtems_scheduler_get_processor_set} - Get processor set of a scheduler
+ at item @code{rtems_task_get_scheduler} - Get scheduler of a task
 @item @code{rtems_task_get_affinity} - Get task processor affinity
 @item @code{rtems_task_set_affinity} - Set task processor affinity
 @end itemize
@@ -374,6 +375,40 @@ cleared bit means the opposite.
 None.
 
 @c
+ at c rtems_task_get_scheduler
+ at c
+ at page
+ at subsection TASK_GET_SCHEDULER - Get scheduler of a task
+
+ at subheading CALLING SEQUENCE:
+
+ at ifset is-C
+ at example
+rtems_status_code rtems_task_get_scheduler(
+  rtems_id  id,
+  rtems_id *scheduler_id
+);
+ at end example
+ at end ifset
+
+ at ifset is-Ada
+ at end ifset
+
+ at subheading DIRECTIVE STATUS CODES:
+
+ at code{@value{RPREFIX}SUCCESSFUL} - successful operation@*
+ at code{@value{RPREFIX}INVALID_ADDRESS} - @code{scheduler_id} is NULL@*
+ at code{@value{RPREFIX}INVALID_ID} - invalid task id
+
+ at subheading DESCRIPTION:
+
+Returns the scheduler identifier of a task in @code{scheduler_id}.
+
+ at subheading NOTES:
+
+None.
+
+ at c
 @c rtems_task_get_affinity
 @c
 @page