diff options
Diffstat (limited to 'spec/rtems/task/if/ident.yml')
| -rw-r--r-- | spec/rtems/task/if/ident.yml | 27 |
1 files changed, 18 insertions, 9 deletions
diff --git a/spec/rtems/task/if/ident.yml b/spec/rtems/task/if/ident.yml index 12523dbc..bfdfb115 100644 --- a/spec/rtems/task/if/ident.yml +++ b/spec/rtems/task/if/ident.yml @@ -1,6 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - Identifies a task object by the specified object name. + Identifies a task 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) @@ -15,7 +15,7 @@ definition: return: ${../../status/if/code:/name} variants: [] description: | - This directive obtains the task identifier associated with the task name + This directive obtains a task identifier associated with the task name specified in ${.:/params[0]/name}. A task may obtain its own identifier by specifying ${self-define:/name} for @@ -40,27 +40,36 @@ links: uid: header - role: interface-ingroup uid: group +- role: constraint + uid: /constraint/directive-ctx-any +- role: constraint + uid: /constraint/directive-no-preempt name: rtems_task_ident notes: | If the task name is not unique, then the task identifier will match the first task with that name in the search order. However, this task identifier is - not guaranteed to correspond to the desired task. The task identifier is - used with other task related directives to access the task. + not guaranteed to correspond to the desired task. - If node is ${../../object/if/search-all-nodes:/name}, all nodes are searched with - the local node being searched first. All other nodes are searched with the - lowest numbered node searched first. + The objects are searched from lowest to the highest index. If + ${.:/params[1]/name} is ${../../object/if/search-all-nodes:/name}, all nodes + are searched with the local node being searched first. All other nodes are + searched from lowest to the highest node number. If node is a valid node number which does not represent the local node, then only the tasks exported by the designated node are searched. This directive does not generate activity on remote nodes. It accesses only the local copy of the global object table. + + The task identifier is used with other task related directives to access the + task. params: -- description: is the object name to look up. +- description: | + is the object name to look up. dir: null name: name -- description: is the node or node set to search for a matching object. +- description: | + is the node or node set to search for a matching object. dir: null name: node - description: | |