[rtems commit] doc: rtems_task_get_affinity()

[Sebastian Huber]

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

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

doc: rtems_task_get_affinity()

---

 doc/user/smp.t |   39 +++++++++++++++------------------------
 1 files changed, 15 insertions(+), 24 deletions(-)

diff --git a/doc/user/smp.t b/doc/user/smp.t
index 37c792f..3a27cbd 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -16,7 +16,7 @@ The application level services currently provided are:
 @itemize @bullet
 @item @code{rtems_get_processor_count} - Get processor count
 @item @code{rtems_get_current_processor} - Get current processor index
- at item @code{rtems_task_get_affinity} - Obtain Task Affinity
+ at item @code{rtems_task_get_affinity} - Get task processor affinity
 @item @code{rtems_task_set_affinity} - Set Task Affinity
 @end itemize
 
@@ -300,18 +300,16 @@ None.
 @c rtems_task_get_affinity
 @c
 @page
- at subsection rtems_task_get_affinity - Obtain Task Affinity
+ at subsection TASK_GET_AFFINITY - Get task processor affinity
 
 @subheading CALLING SEQUENCE:
 
 @ifset is-C
 @example
-#include <rtems.h>
-
 rtems_status_code rtems_task_get_affinity(
-  rtems_id             id,
-  size_t               cpusetsize,
-  cpu_set_t           *cpuset
+  rtems_id   id,
+  size_t     cpusetsize,
+  cpu_set_t *cpuset
 );
 @end example
 @end ifset
@@ -319,30 +317,23 @@ rtems_status_code rtems_task_get_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_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} - the affinity set buffer is too small for
+the current processor affinity set of the task
 
 @subheading DESCRIPTION:
 
-The @code{rtems_task_get_affinity} routine is used to obtain the
- at code{affinityset} field from the thread object @code{id}.
-The value of this field is returned in @code{cpuset}
+Returns the current processor affinity set of the task in @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.
 
 @c
 @c rtems_task_set_affinity