diff options
Diffstat (limited to 'spec/rtems/region/if/ident.yml')
| -rw-r--r-- | spec/rtems/region/if/ident.yml | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/spec/rtems/region/if/ident.yml b/spec/rtems/region/if/ident.yml index f67af7d2..4710f880 100644 --- a/spec/rtems/region/if/ident.yml +++ b/spec/rtems/region/if/ident.yml @@ -1,6 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - Identifies a region object by the specified object name. + Identifies a region 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 region identifier associated with the region name + This directive obtains a region identifier associated with the region name specified in ${.:/params[0]/name}. enabled-by: true index-entries: [] @@ -24,17 +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_region_ident notes: | If the region name is not unique, then the region identifier will match the first region with that name in the search order. However, this region - identifier is not guaranteed to correspond to the desired region. The region - identifier is used with other region related directives to access the region. + identifier is not guaranteed to correspond to the desired region. The objects are searched from lowest to the highest index. Only the local node is searched. + + The region identifier is used with other region related directives to access + the region. params: -- description: is the object name to look up. +- description: | + is the object name to look up. dir: null name: name - description: | |