diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-06-11 09:20:23 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-06-14 09:15:40 +0200 |
commit | 6ee44e161cdd597de8bc3614bf97d0dd2b72bbe7 (patch) | |
tree | f708558f30ac85d881df49bb190b78aa7cb99145 /spec/rtems/task/if | |
parent | modules: Update rtems (diff) | |
download | rtems-central-6ee44e161cdd597de8bc3614bf97d0dd2b72bbe7.tar.bz2 |
spec: Use a common phrase for pointer parameters
Diffstat (limited to 'spec/rtems/task/if')
-rw-r--r-- | spec/rtems/task/if/construct.yml | 6 | ||||
-rw-r--r-- | spec/rtems/task/if/create.yml | 6 | ||||
-rw-r--r-- | spec/rtems/task/if/get-affinity.yml | 16 | ||||
-rw-r--r-- | spec/rtems/task/if/get-priority.yml | 4 | ||||
-rw-r--r-- | spec/rtems/task/if/get-scheduler.yml | 7 | ||||
-rw-r--r-- | spec/rtems/task/if/ident.yml | 6 | ||||
-rw-r--r-- | spec/rtems/task/if/mode.yml | 6 | ||||
-rw-r--r-- | spec/rtems/task/if/set-affinity.yml | 13 | ||||
-rw-r--r-- | spec/rtems/task/if/set-priority.yml | 4 |
9 files changed, 35 insertions, 33 deletions
diff --git a/spec/rtems/task/if/construct.yml b/spec/rtems/task/if/construct.yml index 5b97b6f1..034132d7 100644 --- a/spec/rtems/task/if/construct.yml +++ b/spec/rtems/task/if/construct.yml @@ -67,9 +67,9 @@ params: dir: null name: config - description: | - is the pointer to an object identifier variable. When the directive call - is successful, the identifier of the constructed task will be stored in - this variable. + is the pointer to an ${../../type/if/id:/name} object. When the directive + call is successful, the identifier of the constructed task will be stored + in this object. dir: out name: id return: diff --git a/spec/rtems/task/if/create.yml b/spec/rtems/task/if/create.yml index 362baffd..4d49ac74 100644 --- a/spec/rtems/task/if/create.yml +++ b/spec/rtems/task/if/create.yml @@ -225,9 +225,9 @@ params: dir: null name: attribute_set - description: | - is the pointer to an object identifier variable. When the directive call - is successful, the identifier of the created task will be stored in this - variable. + is the pointer to an ${../../type/if/id:/name} object. When the directive + call is successful, the identifier of the created task will be stored in + this object. dir: out name: id return: diff --git a/spec/rtems/task/if/get-affinity.yml b/spec/rtems/task/if/get-affinity.yml index b28df7b5..df46c6ff 100644 --- a/spec/rtems/task/if/get-affinity.yml +++ b/spec/rtems/task/if/get-affinity.yml @@ -42,15 +42,16 @@ params: dir: null name: id - description: | - is the size of the referenced processor set variable in bytes. + is the size of the processor set referenced by ${.:/params[2]/name} in + bytes. dir: null name: cpusetsize - description: | - is the pointer to a processor set variable. When the directive call is - successful, the processor affinity set of the task will be stored in this - variable. A set bit in the processor set means that the corresponding - processor is in the processor affinity set of the task, otherwise the bit - is cleared. + is the pointer to a ${/c/if/cpu_set_t:/name} object. When the directive + call is successful, the processor affinity set of the task will be stored + in this object. A set bit in the processor set means that the + corresponding processor is in the processor affinity set of the task, + otherwise the bit is cleared. dir: out name: cpuset return: @@ -67,7 +68,8 @@ return: ${.:/params[0]/name}. value: ${../../status/if/invalid-id:/name} - description: | - The provided processor set was too small for the processor affinity set of the task. + The size specified by ${.:/params[1]/name} of the processor set was too + small for the processor affinity set of the task. value: ${../../status/if/invalid-size:/name} - description: | The task resided on a remote node. diff --git a/spec/rtems/task/if/get-priority.yml b/spec/rtems/task/if/get-priority.yml index 2928bc16..d4b5af9f 100644 --- a/spec/rtems/task/if/get-priority.yml +++ b/spec/rtems/task/if/get-priority.yml @@ -53,9 +53,9 @@ params: dir: null name: scheduler_id - description: | - is the pointer to an ${../../type/if/priority:/name} variable. When the + is the pointer to an ${../../type/if/priority:/name} object. When the directive call is successful, the current priority of the task with respect - to the specified scheduler will be stored in this variable. + to the specified scheduler will be stored in this object. dir: out name: priority return: diff --git a/spec/rtems/task/if/get-scheduler.yml b/spec/rtems/task/if/get-scheduler.yml index f3dbc54d..3bba795e 100644 --- a/spec/rtems/task/if/get-scheduler.yml +++ b/spec/rtems/task/if/get-scheduler.yml @@ -42,10 +42,9 @@ params: dir: null name: task_id - description: | - is the pointer to an ${../../type/if/id:/name} variable. When the - directive call is successful, the identifier of the - ${/glossary/scheduler-home:/term} of the task will be stored in this - variable. + is the pointer to an ${../../type/if/id:/name} object. When the directive + call is successful, the identifier of the ${/glossary/scheduler-home:/term} + of the task will be stored in this object. dir: out name: scheduler_id return: diff --git a/spec/rtems/task/if/ident.yml b/spec/rtems/task/if/ident.yml index b8fbf4bc..1b4e67aa 100644 --- a/spec/rtems/task/if/ident.yml +++ b/spec/rtems/task/if/ident.yml @@ -73,9 +73,9 @@ params: dir: null name: node - description: | - is the pointer to an object identifier variable. When the directive call - is successful, the object identifier of an object with the specified name - will be stored in this variable. + is the pointer to an ${../../type/if/id:/name} object. When the directive + call is successful, the object identifier of an object with the specified + name will be stored in this object. dir: out name: id return: diff --git a/spec/rtems/task/if/mode.yml b/spec/rtems/task/if/mode.yml index 5cfb0e6b..c8071550 100644 --- a/spec/rtems/task/if/mode.yml +++ b/spec/rtems/task/if/mode.yml @@ -132,9 +132,9 @@ params: dir: null name: mask - description: | - is the pointer to a mode variable. When the directive call - is successful, the mode of the task before any mode changes done by the - directive call will be stored in this variable. + is the pointer to an ${../../mode/if/mode:/name} object. When the + directive call is successful, the mode of the task before any mode changes + done by the directive call will be stored in this object. dir: null name: previous_mode_set return: diff --git a/spec/rtems/task/if/set-affinity.yml b/spec/rtems/task/if/set-affinity.yml index 6323dab9..6257bde0 100644 --- a/spec/rtems/task/if/set-affinity.yml +++ b/spec/rtems/task/if/set-affinity.yml @@ -42,15 +42,16 @@ params: dir: null name: id - description: | - is the size of the referenced processor set variable in bytes. + is the size of the processor set referenced by ${.:/params[2]/name} in + bytes. dir: null name: cpusetsize - description: | - is the pointer to a processor set variable. The processor set defines the - new processor affinity set of the task. A set bit in the processor set - means that the corresponding processor shall be in the processor affinity - set of the task, otherwise the bit shall be cleared. - dir: null + is the pointer to a ${/c/if/cpu_set_t:/name} object. The processor set + defines the new processor affinity set of the task. A set bit in the + processor set means that the corresponding processor shall be in the + processor affinity set of the task, otherwise the bit shall be cleared. + dir: out name: cpuset return: return: null diff --git a/spec/rtems/task/if/set-priority.yml b/spec/rtems/task/if/set-priority.yml index d667bd8e..2ea06163 100644 --- a/spec/rtems/task/if/set-priority.yml +++ b/spec/rtems/task/if/set-priority.yml @@ -69,10 +69,10 @@ params: dir: null name: new_priority - description: | - is the pointer to an ${../../type/if/priority:/name} variable. When the + is the pointer to an ${../../type/if/priority:/name} object. When the directive call is successful, the current or previous priority of the task with respect to its ${/glossary/scheduler-home:/term} will be stored in - this variable. + this object. dir: out name: old_priority return: |