[PATCH 2/2] barrier: Remove unfinished sentence
gedare at rtems.org
Tue Oct 1 22:04:16 UTC 2019
On Tue, Oct 1, 2019 at 11:09 AM Martin Erik Werner
<martinerikwerner at gmail.com> wrote:
> Remove the unfinished sentence
> "Since a barrier is, by definition, never immediately [...]"
> and jump directly to
> "The task may wait [forever or for a timeout]"
> I cannot figure out what the unfinished sentence is supposed to be -
> "released"? "passed"?
This unfinished sentence seems to exist since the barrier
documentation was introduced. Maybe Joel remembers. My guess is that
it was starting to say "never immediately available", although I don't
think that is true for an automatic release barrier. Your rewrite
looks good to me.
> c-user/barrier_manager.rst | 7 +++----
> 1 file changed, 3 insertions(+), 4 deletions(-)
> diff --git a/c-user/barrier_manager.rst b/c-user/barrier_manager.rst
> index e5d69b0..9a57645 100644
> --- a/c-user/barrier_manager.rst
> +++ b/c-user/barrier_manager.rst
> @@ -119,10 +119,9 @@ Waiting at a Barrier
> The ``rtems_barrier_wait`` directive is used to wait at
> -the specified barrier. Since a barrier is, by definition, never immediately,
> -the task may wait forever for the barrier to be released or it may
> -specify a timeout. Specifying a timeout limits the interval the task will
> -wait before returning with an error status code.
> +the specified barrier. The task may wait forever for the barrier to be
> +released or it may specify a timeout. Specifying a timeout limits the interval
> +the task will wait before returning with an error status code.
> If the barrier is configured as automatic and there are already one less then
> the maximum number of waiters, then the call will unblock all tasks waiting at
> devel mailing list
> devel at rtems.org
More information about the devel