[rtems commit] doc: rtems_task_set_affinity()

[Sebastian Huber]

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

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

doc: rtems_task_set_affinity()

---

 doc/user/Makefile.am |    2 +-
 doc/user/smp.t       |   45 ++++++++++++++-------------------------------
 2 files changed, 15 insertions(+), 32 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 3a27cbd..d0bb240 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -17,7 +17,7 @@ The application level services currently provided are:
 @item @code{rtems_get_processor_count} - Get processor count
 @item @code{rtems_get_current_processor} - Get current processor index
 @item @code{rtems_task_get_affinity} - Get task processor affinity
- at item @code{rtems_task_set_affinity} - Set Task Affinity
+ at item @code{rtems_task_set_affinity} - Set task processor affinity
 @end itemize
 
 @c
@@ -339,18 +339,16 @@ None.
 @c rtems_task_set_affinity
 @c
 @page
- at subsection rtems_task_set_affinity - Set Task Affinity
+ at 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
@@ -358,34 +356,19 @@ rtems_status_code rtems_task_set_affinity(
 @ifset is-Ada
 @end ifset
 
- at subheading STATUS CODES:
-
- at table @b
- at item RTEMS_UNSATISFIED
-The @code{cpuset} pointer argument is invalid.
-
- at item RTEMS_UNSATISFIED
-The @code{cpusetsize} does not match the value of @code{affinitysetsize}
-field in the thread attribute object.
-
- at item RTEMS_UNSATISFIED
-The @code{cpuset} did not select a valid cpu.
-
- at item RTEMS_UNSATISFIED
-The @code{cpuset} selected a cpu that was invalid.
-
- at item RTEMS_INVALID_ID
-The @code{id} is invalid.
+ at subheading DIRECTIVE STATUS CODES:
 
- at end table
+ at code{@value{RPREFIX}SUCCESSFUL} - successful operation@*
+ at code{@value{RPREFIX}INVALID_ADDRESS} - @code{cpuset} is NULL@*
+ at code{@value{RPREFIX}INVALID_ID} - invalid task id@*
+ at code{@value{RPREFIX}INVALID_NUMBER} - invalid processor affinity set
 
 @subheading DESCRIPTION:
 
-The @code{rtems_task_set_affinity} routine is used to set the
- at 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.