[rtems-docs commit] barrier: Remove leftover semaphore remnants
joel at rtems.org
Thu Nov 7 00:37:53 UTC 2019
Author: Martin Erik Werner <martinerikwerner at gmail.com>
Date: Wed Sep 4 22:47:00 2019 +0200
barrier: Remove leftover semaphore remnants
Remove various incorrect references to "lock" and "obtain" and to an
option set which is not part of the barrier interface.
It looks like the barrier documentation was started based on a copy of
the semaphore documentation and these things are surviving remnants.
Also remove an unfinished sentence in the barrier wait description,
since the intended information is already provided in the under the NOTE
c-user/barrier_manager.rst | 38 +++++++-------------------------------
1 file changed, 7 insertions(+), 31 deletions(-)
diff --git a/c-user/barrier_manager.rst b/c-user/barrier_manager.rst
index b0bf3bf..e5d69b0 100644
@@ -324,8 +324,7 @@ NOTES:
-.. index:: obtain a barrier
-.. index:: lock a barrier
+.. index:: wait at a barrier
.. index:: rtems_barrier_wait
BARRIER_WAIT - Wait at a barrier
@@ -356,14 +355,11 @@ DIRECTIVE STATUS CODES:
- This directive acquires the barrier specified by ``id``. The
- ``RTEMS_WAIT`` and ``RTEMS_NO_WAIT`` components of the options parameter
- indicate whether the calling task wants to wait for the barrier to become
- available or return immediately if the barrier is not currently available.
- With either ``RTEMS_WAIT`` or ``RTEMS_NO_WAIT``, if the current barrier
- count is positive, then it is decremented by one and the barrier is
- successfully acquired by returning immediately with a successful return
+ This directive waits at the barrier specified by ``id``. The timeout
+ parameter specifies the maximum interval the calling task is willing to be
+ blocked waiting for the barrier. If it is set to ``RTEMS_NO_TIMEOUT``,
+ then the calling task will wait forever. If the barrier is available or
+ the ``RTEMS_NO_WAIT`` option component is set, then timeout is ignored.
Conceptually, the calling task should always be thought of as blocking when
it makes this call and being unblocked when the barrier is released. If
@@ -372,24 +368,7 @@ DESCRIPTION:
callers will block except for the one which is the Nth task which trips the
automatic release condition.
- The timeout parameter specifies the maximum interval the calling task is
- willing to be blocked waiting for the barrier. If it is set to
- ``RTEMS_NO_TIMEOUT``, then the calling task will wait forever. If the
- barrier is available or the ``RTEMS_NO_WAIT`` option component is set, then
- timeout is ignored.
- The following barrier acquisition option constants are defined by RTEMS:
- .. list-table::
- :class: rtems-table
- * - ``RTEMS_WAIT``
- - task will wait for barrier (default)
- * - ``RTEMS_NO_WAIT``
- - task should not wait
A clock tick is required to support the timeout functionality of this
@@ -399,7 +378,6 @@ NOTES:
-.. index:: wait at a barrier
.. index:: release a barrier
.. index:: rtems_barrier_release
@@ -425,9 +403,7 @@ DIRECTIVE STATUS CODES:
This directive releases the barrier specified by id. All tasks waiting at
- the barrier will be unblocked. If the running task's preemption mode is
- enabled and one of the unblocked tasks has a higher priority than the
- running task.
+ the barrier will be unblocked.
The calling task may be preempted if it causes a higher priority task to be
More information about the vc