[rtems commit] rtems: Document rtems_task_set_scheduler() errors

[Sebastian Huber]

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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed May 12 16:30:28 2021 +0200

rtems: Document rtems_task_set_scheduler() errors

---

 cpukit/include/rtems/rtems/tasks.h | 23 ++++++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

diff --git a/cpukit/include/rtems/rtems/tasks.h b/cpukit/include/rtems/rtems/tasks.h
index 73cf769..be95768 100644
--- a/cpukit/include/rtems/rtems/tasks.h
+++ b/cpukit/include/rtems/rtems/tasks.h
@@ -2142,13 +2142,30 @@ rtems_status_code rtems_task_get_scheduler(
  * @retval ::RTEMS_INVALID_ID There was no scheduler associated with the
  *   identifier specified by ``scheduler_id``.
  *
- * @retval ::RTEMS_INVALID_PRIORITY There task priority specified in
- *   ``priority`` was invalid with respect to the scheduler specified by
- *   ``scheduler_id``.
+ * @retval ::RTEMS_INVALID_PRIORITY The task priority specified by ``priority``
+ *   was invalid with respect to the scheduler specified by ``scheduler_id``.
  *
  * @retval ::RTEMS_INVALID_ID There was no task associated with the identifier
  *   specified by ``task_id``.
  *
+ * @retval ::RTEMS_RESOURCE_IN_USE The task specified by ``task_id`` was
+ *   enqueued on a wait queue.
+ *
+ * @retval ::RTEMS_RESOURCE_IN_USE The task specified by ``task_id`` had a
+ *   current priority which consisted of more than the real priority.
+ *
+ * @retval ::RTEMS_RESOURCE_IN_USE The task specified by ``task_id`` had a
+ *   helping scheduler.
+ *
+ * @retval ::RTEMS_RESOURCE_IN_USE The task specified by ``task_id`` was
+ *   pinned.
+ *
+ * @retval ::RTEMS_UNSATISFIED The scheduler specified by ``scheduler_id``
+ *   owned no processor.
+ *
+ * @retval ::RTEMS_UNSATISFIED The scheduler specified by ``scheduler_id`` did
+ *   not support the affinity set of the task specified by ``task_id``.
+ *
  * @retval ::RTEMS_ILLEGAL_ON_REMOTE_OBJECT The task resided on a remote node.
  *
  * @par Constraints