summaryrefslogtreecommitdiffstats
path: root/doc/user/smp.t
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2014-05-20 10:03:35 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2014-05-20 10:03:35 +0200
commite5274df1d958a3252dcf3b56b4330047aea552fa (patch)
treeddc5f413ad54c7d73097c8cef6e6128463ee86d1 /doc/user/smp.t
parentscore: SMP scheduler support documentation (diff)
downloadrtems-e5274df1d958a3252dcf3b56b4330047aea552fa.tar.bz2
rtems: Clarify task set/get scheduler parameters
Diffstat (limited to '')
-rw-r--r--doc/user/smp.t12
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/user/smp.t b/doc/user/smp.t
index 1844315017..a040b70910 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -446,7 +446,7 @@ None.
@ifset is-C
@example
rtems_status_code rtems_task_get_scheduler(
- rtems_id id,
+ rtems_id task_id,
rtems_id *scheduler_id
);
@end example
@@ -463,7 +463,8 @@ rtems_status_code rtems_task_get_scheduler(
@subheading DESCRIPTION:
-Returns the scheduler identifier of a task in @code{scheduler_id}.
+Returns the scheduler identifier of a task identified by @code{task_id} in
+@code{scheduler_id}.
@subheading NOTES:
@@ -480,7 +481,7 @@ None.
@ifset is-C
@example
rtems_status_code rtems_task_set_scheduler(
- rtems_id id,
+ rtems_id task_id,
rtems_id scheduler_id
);
@end example
@@ -498,8 +499,9 @@ perform a scheduler change
@subheading DESCRIPTION:
-Sets the scheduler of a task specified by @code{scheduler_id}. The scheduler
-of a task is initialized to the scheduler of the task that created it.
+Sets the scheduler of a task identified by @code{task_id} to the scheduler
+identified by @code{scheduler_id}. The scheduler of a task is initialized to
+the scheduler of the task that created it.
@subheading NOTES: