[PATCH] c-user: Document rtems_task_set_scheduler() errors

[Gedare Bloom]

ok

On Wed, May 12, 2021 at 7:06 AM Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
>
> ---
>  c-user/task/directives.rst | 24 ++++++++++++++++++++++--
>  1 file changed, 22 insertions(+), 2 deletions(-)
>
> diff --git a/c-user/task/directives.rst b/c-user/task/directives.rst
> index 2bfb8af..c0ef4e7 100644
> --- a/c-user/task/directives.rst
> +++ b/c-user/task/directives.rst
> @@ -1702,12 +1702,32 @@ This directive sets the :term:`home scheduler` to the scheduler specified by
>      ``scheduler_id``.
>
>  :c:macro:`RTEMS_INVALID_PRIORITY`
> -    There task priority specified in ``priority`` was invalid with respect to
> -    the scheduler specified by ``scheduler_id``.
> +    The task priority specified by ``priority`` was invalid with respect to the
> +    scheduler specified by ``scheduler_id``.
>
>  :c:macro:`RTEMS_INVALID_ID`
>      There was no task associated with the identifier specified by ``task_id``.
>
> +:c:macro:`RTEMS_RESOURCE_IN_USE`
> +    The task specified by ``task_id`` was enqueued on a :term:`wait queue`.
> +
> +:c:macro:`RTEMS_RESOURCE_IN_USE`
> +    The task specified by ``task_id`` had a :term:`current priority` which
> +    consisted of more than the :term:`real priority`.
> +
> +:c:macro:`RTEMS_RESOURCE_IN_USE`
> +    The task specified by ``task_id`` had a :term:`helping scheduler`.
> +
> +:c:macro:`RTEMS_RESOURCE_IN_USE`
> +    The task specified by ``task_id`` was pinned.
> +
> +:c:macro:`RTEMS_UNSATISFIED`
> +    The scheduler specified by ``scheduler_id`` owned no processor.
> +
> +:c:macro:`RTEMS_UNSATISFIED`
> +    The scheduler specified by ``scheduler_id`` did not support the affinity
> +    set of the task specified by ``task_id``.
> +
>  :c:macro:`RTEMS_ILLEGAL_ON_REMOTE_OBJECT`
>      The task resided on a remote node.
>
> --
> 2.26.2
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel