summaryrefslogtreecommitdiffstats
path: root/spec/rtems/barrier/if/ident.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/barrier/if/ident.yml')
-rw-r--r--spec/rtems/barrier/if/ident.yml18
1 files changed, 12 insertions, 6 deletions
diff --git a/spec/rtems/barrier/if/ident.yml b/spec/rtems/barrier/if/ident.yml
index d99a65d2..f7cc00bb 100644
--- a/spec/rtems/barrier/if/ident.yml
+++ b/spec/rtems/barrier/if/ident.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Identifies a barrier object by the specified object name.
+ Identifies a barrier by the object name.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
@@ -14,7 +14,7 @@ definition:
return: ${../../status/if/code:/name}
variants: []
description: |
- This directive obtains the barrier identifier associated with the barrier
+ This directive obtains a barrier identifier associated with the barrier
name specified in ${.:/params[0]/name}.
enabled-by: true
index-entries: []
@@ -24,18 +24,24 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_barrier_ident
notes: |
If the barrier name is not unique, then the barrier identifier will match the
first barrier with that name in the search order. However, this barrier
- identifier is not guaranteed to correspond to the desired barrier. The
- barrier identifier is used with other barrier related directives to access
- the barrier.
+ identifier is not guaranteed to correspond to the desired barrier.
The objects are searched from lowest to the highest index. Only the local
node is searched.
+
+ The barrier identifier is used with other barrier related directives to
+ access the barrier.
params:
-- description: is the object name to look up.
+- description: |
+ is the object name to look up.
dir: null
name: name
- description: |