summaryrefslogtreecommitdiffstats
path: root/doc/user/smp.t
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2014-05-28 18:11:51 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2014-06-02 08:28:42 +0200
commit25f5730fe515911e42591f66294baff0369d9883 (patch)
treea6ab2d7c98499ec959d4272a2ec9bd6069589e09 /doc/user/smp.t
parentscore: _Scheduler_Get_affinity() (diff)
downloadrtems-25f5730fe515911e42591f66294baff0369d9883.tar.bz2
score: _Scheduler_Set_affinity()
Do not change the scheduler with this function. Documentation. Coding style.
Diffstat (limited to 'doc/user/smp.t')
-rw-r--r--doc/user/smp.t10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/user/smp.t b/doc/user/smp.t
index a040b70910..dd84c37360 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -622,4 +622,12 @@ cleared bit means the opposite.
@subheading NOTES:
-None.
+This function will not change the scheduler of the task. The intersection of
+the processor affinity set and the set of processors owned by the scheduler of
+the task must be non-empty. It is not an error if the processor affinity set
+contains processors that are not part of the set of processors owned by the
+scheduler instance of the task. A task will simply not run under normal
+circumstances on these processors since the scheduler ignores them. Some
+locking protocols may temporarily use processors that are not included in the
+processor affinity set of the task. It is also not an error if the processor
+affinity set contains processors that are not part of the system.