---
doc/user/Makefile.am | 2 +-
doc/user/smp.t | 43 +++++++++++++------------------------------
2 files changed, 14 insertions(+), 31 deletions(-)
diff --git a/doc/user/Makefile.am b/doc/user/Makefile.am
index 03f776d..ef91a41 100644
--- a/doc/user/Makefile.am
+++ b/doc/user/Makefile.am
@@ -169,7 +169,7 @@ smp.texi: smp.t
-n "Stack Bounds Checker" < $< > $@
stackchk.texi: stackchk.t
- $(BMENU2) -p "Symmetric Multiprocessing Services
rtems_task_set_affinity - Set Task Affinity" \
+ $(BMENU2) -p "Symmetric Multiprocessing Services TASK_SET_AFFINITY -
Set task processor affinity" \
-u "Top" \
-n "CPU Usage Statistics" < $< > $@
diff --git a/doc/user/smp.t b/doc/user/smp.t
index 649aaf1..ced8fdf 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -338,18 +338,16 @@ None.
@c rtems_task_set_affinity
@c
@page
-@subsection rtems_task_set_affinity - Set Task Affinity
+@subsection TASK_SET_AFFINITY - Set task processor affinity
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-#include <rtems.h>
-
rtems_status_code rtems_task_set_affinity(
- rtems_id id,
- size_t cpusetsize,
- cpu_set_t *cpuset
+ rtems_id id,
+ size_t cpusetsize,
+ const cpu_set_t *cpuset
);
@end example
@end ifset
@@ -357,34 +355,19 @@ rtems_status_code rtems_task_set_affinity(
@ifset is-Ada
@end ifset
-@subheading STATUS CODES:
-
-@table @b
-@item RTEMS_UNSATISFIED
-The @code{cpuset} pointer argument is invalid.
-
-@item RTEMS_UNSATISFIED
-The @code{cpusetsize} does not match the value of @code{affinitysetsize}
-field in the thread attribute object.
-
-@item RTEMS_UNSATISFIED
-The @code{cpuset} did not select a valid cpu.
-
-@item RTEMS_UNSATISFIED
-The @code{cpuset} selected a cpu that was invalid.
-
-@item RTEMS_INVALID_ID
-The @code{id} is invalid.
+@subheading DIRECTIVE STATUS CODES:
-@end table
+@code{@value{RPREFIX}SUCCESSFUL} - successful operation@*
+@code{@value{RPREFIX}INVALID_ADDRESS} - @code{cpuset} is NULL@*
+@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
+@code{@value{RPREFIX}INVALID_NUMBER} - invalid processor affinity set
@subheading DESCRIPTION:
-The @code{rtems_task_set_affinity} routine is used to set the
-@code{affinity.set} field of the thread control object associated
-with @code{id}. This value controls the @code{cpuset} that the task can
-execute on.
+Sets the processor affinity set for the task specified by @code{cpuset}. A set
+bit in the affinity set means that the task can execute on this processor and a
+cleared bit means the opposite.
@subheading NOTES:
-NONE
+None.
--
1.7.7
_______________________________________________
rtems-devel mailing list
rtems-devel@rtems.org
http://www.rtems.org/mailman/listinfo/rtems-devel
