summaryrefslogtreecommitdiffstats
path: root/c-user/semaphore/introduction.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-09-29 16:44:14 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-02-10 17:19:00 +0100
commitfd56f7e469991b0c27826577e75a69668ff6411f (patch)
tree5e467356114bf7a4b8965d2104a3eb420c2c6638 /c-user/semaphore/introduction.rst
parentc-user: Move deprecated/removed directives (diff)
downloadrtems-docs-fd56f7e469991b0c27826577e75a69668ff6411f.tar.bz2
c-user: Generate semaphore 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/semaphore/introduction.rst52
1 files changed, 41 insertions, 11 deletions
diff --git a/c-user/semaphore/introduction.rst b/c-user/semaphore/introduction.rst
index dee298b..9c36834 100644
--- a/c-user/semaphore/introduction.rst
+++ b/c-user/semaphore/introduction.rst
@@ -1,25 +1,55 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
+.. 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/sem/if/group
+
+.. _SemaphoreManagerIntroduction:
+
Introduction
============
-The semaphore manager utilizes standard Dijkstra
-counting semaphores to provide synchronization and mutual
-exclusion capabilities. The directives provided by the
-semaphore manager are:
+.. The following list was generated from:
+.. spec:/rtems/sem/if/create
+.. spec:/rtems/sem/if/ident
+.. spec:/rtems/sem/if/delete
+.. spec:/rtems/sem/if/obtain
+.. spec:/rtems/sem/if/release
+.. spec:/rtems/sem/if/flush
+.. spec:/rtems/sem/if/set-priority
+
+The Semaphore Manager utilizes standard Dijkstra counting semaphores to provide
+synchronization and mutual exclusion capabilities. The directives provided by
+the Semaphore Manager are:
-- :ref:`rtems_semaphore_create`
+* :ref:`InterfaceRtemsSemaphoreCreate` - Creates a semaphore.
-- :ref:`rtems_semaphore_ident`
+* :ref:`InterfaceRtemsSemaphoreIdent` - Identifies a semaphore by the object
+ name.
-- :ref:`rtems_semaphore_delete`
+* :ref:`InterfaceRtemsSemaphoreDelete` - Deletes the semaphore.
-- :ref:`rtems_semaphore_obtain`
+* :ref:`InterfaceRtemsSemaphoreObtain` - Obtains the semaphore.
-- :ref:`rtems_semaphore_release`
+* :ref:`InterfaceRtemsSemaphoreRelease` - Releases the semaphore.
-- :ref:`rtems_semaphore_flush`
+* :ref:`InterfaceRtemsSemaphoreFlush` - Flushes the semaphore.
-- :ref:`rtems_semaphore_set_priority`
+* :ref:`InterfaceRtemsSemaphoreSetPriority` - Sets the priority by scheduler
+ for the semaphore.