diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-01-18 08:51:42 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-02-10 17:19:00 +0100 |
commit | 62718adaa877c7b7ffb93270e7ddc48eebd7e368 (patch) | |
tree | cf51d5a314f484468dfd91447014411f4733caf6 /c-user/barrier/introduction.rst | |
parent | c-user: Generate semaphore manager documentation (diff) | |
download | rtems-docs-62718adaa877c7b7ffb93270e7ddc48eebd7e368.tar.bz2 |
c-user: Generate barrier manager documentation
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup. The documentation was
transfered to interface specification items. The documentation source
files were generated from the items by a script.
Update #3993.
Diffstat (limited to '')
-rw-r--r-- | c-user/barrier/introduction.rst | 45 |
1 files changed, 36 insertions, 9 deletions
diff --git a/c-user/barrier/introduction.rst b/c-user/barrier/introduction.rst index 5965eed..11013bf 100644 --- a/c-user/barrier/introduction.rst +++ b/c-user/barrier/introduction.rst @@ -1,20 +1,47 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. Copyright (C) 1988, 2018 On-Line Applications Research Corporation (OAR) +.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de) +.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) + +.. This file is part of the RTEMS quality process and was automatically +.. generated. If you find something that needs to be fixed or +.. worded better please post a report or patch to an RTEMS mailing list +.. or raise a bug report: +.. +.. https://www.rtems.org/bugs.html +.. +.. For information on updating and regenerating please refer to the How-To +.. section in the Software Requirements Engineering chapter of the +.. RTEMS Software Engineering manual. The manual is provided as a part of +.. a release. For development sources please refer to the online +.. documentation at: +.. +.. https://docs.rtems.org + +.. Generated from spec:/rtems/barrier/if/group + +.. _BarrierManagerIntroduction: Introduction ============ -The barrier manager provides a unique synchronization capability which can be -used to have a set of tasks block and be unblocked as a set. The directives -provided by the barrier manager are: +.. The following list was generated from: +.. spec:/rtems/barrier/if/create +.. spec:/rtems/barrier/if/ident +.. spec:/rtems/barrier/if/delete +.. spec:/rtems/barrier/if/wait +.. spec:/rtems/barrier/if/release -- :ref:`rtems_barrier_create` +The Barrier Manager provides a unique synchronization capability which can be +used to have a set of tasks block and be unblocked as a set. The directives +provided by the Barrier Manager are: -- :ref:`rtems_barrier_ident` +* :ref:`InterfaceRtemsBarrierCreate` - Creates a barrier. -- :ref:`rtems_barrier_delete` +* :ref:`InterfaceRtemsBarrierIdent` - Identifies a barrier by the object name. -- :ref:`rtems_barrier_wait` +* :ref:`InterfaceRtemsBarrierDelete` - Deletes the barrier. -- :ref:`rtems_barrier_release` +* :ref:`InterfaceRtemsBarrierWait` - Waits at the barrier. + +* :ref:`InterfaceRtemsBarrierRelease` - Releases the barrier. |