[rtems-central commit] spec: Use EARS syntax
Sebastian Huber
sebh at rtems.org
Wed Feb 17 17:48:06 UTC 2021
Module: rtems-central
Branch: master
Commit: 0da6598dd0defdccd9944a8571f2253a2ac1f55c
Changeset: http://git.rtems.org/rtems-central/commit/?id=0da6598dd0defdccd9944a8571f2253a2ac1f55c
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Wed Feb 10 16:04:24 2021 +0100
spec: Use EARS syntax
---
spec/rtems/barrier/if/create.yml | 6 +++---
spec/rtems/barrier/if/ident.yml | 6 +++---
spec/rtems/barrier/if/release.yml | 4 ++--
spec/rtems/dpmem/if/create.yml | 6 +++---
spec/rtems/dpmem/if/ident.yml | 6 +++---
spec/rtems/io/if/register-driver.yml | 6 +++---
spec/rtems/message/if/construct.yml | 6 +++---
spec/rtems/message/if/create.yml | 6 +++---
spec/rtems/message/if/ident.yml | 6 +++---
spec/rtems/object/if/get-class-information.yml | 6 +++---
spec/rtems/object/if/get-classic-name.yml | 6 +++---
spec/rtems/part/if/create.yml | 6 +++---
spec/rtems/part/if/get-buffer.yml | 5 +++--
spec/rtems/part/if/ident.yml | 6 +++---
spec/rtems/ratemon/if/create.yml | 6 +++---
spec/rtems/ratemon/if/ident.yml | 6 +++---
spec/rtems/region/if/create.yml | 6 +++---
spec/rtems/region/if/ident.yml | 6 +++---
spec/rtems/scheduler/if/get-processor-set.yml | 14 +++++++-------
spec/rtems/scheduler/if/ident-by-processor-set.yml | 16 ++++++++--------
spec/rtems/scheduler/if/ident-by-processor.yml | 6 +++---
spec/rtems/scheduler/if/ident.yml | 6 +++---
spec/rtems/scheduler/if/map-priority-from-posix.yml | 8 ++++----
spec/rtems/scheduler/if/map-priority-to-posix.yml | 6 +++---
spec/rtems/sem/if/create.yml | 6 +++---
spec/rtems/sem/if/ident.yml | 6 +++---
spec/rtems/sem/if/set-priority.yml | 6 +++---
spec/rtems/task/if/construct.yml | 6 +++---
spec/rtems/task/if/create.yml | 6 +++---
spec/rtems/task/if/ident.yml | 6 +++---
spec/rtems/timer/if/create.yml | 6 +++---
spec/rtems/timer/if/get-information.yml | 5 +++--
spec/rtems/timer/if/ident.yml | 6 +++---
spec/rtems/userext/if/create.yml | 6 +++---
spec/rtems/userext/if/ident.yml | 6 +++---
35 files changed, 114 insertions(+), 112 deletions(-)
diff --git a/spec/rtems/barrier/if/create.yml b/spec/rtems/barrier/if/create.yml
index 74deb81..10b606e 100644
--- a/spec/rtems/barrier/if/create.yml
+++ b/spec/rtems/barrier/if/create.yml
@@ -84,9 +84,9 @@ params:
dir: null
name: maximum_waiters
- description: |
- is the pointer to an object identifier variable. The identifier of the
- created barrier will be stored in this variable, in case of a successful
- operation.
+ is the pointer to an object identifier variable. When the directive call
+ is successful, the identifier of the created barrier will be stored in this
+ variable.
dir: null
name: id
return:
diff --git a/spec/rtems/barrier/if/ident.yml b/spec/rtems/barrier/if/ident.yml
index f7cc00b..109d82d 100644
--- a/spec/rtems/barrier/if/ident.yml
+++ b/spec/rtems/barrier/if/ident.yml
@@ -45,9 +45,9 @@ params:
dir: null
name: name
- description: |
- is the pointer to an object identifier variable. The object identifier of
- an object with the specified name will be stored in this variable, in case
- of a successful operation.
+ 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.
dir: out
name: id
return:
diff --git a/spec/rtems/barrier/if/release.yml b/spec/rtems/barrier/if/release.yml
index 309687a..518659b 100644
--- a/spec/rtems/barrier/if/release.yml
+++ b/spec/rtems/barrier/if/release.yml
@@ -40,8 +40,8 @@ params:
dir: null
name: id
- description: |
- is the pointer to an integer variable. The number of released tasks will
- be stored in this variable, in case of a successful operation.
+ is the pointer to an integer variable. When the directive call is
+ successful, the number of released tasks will be stored in this variable.
dir: out
name: released
return:
diff --git a/spec/rtems/dpmem/if/create.yml b/spec/rtems/dpmem/if/create.yml
index b4c78bf..eac8378 100644
--- a/spec/rtems/dpmem/if/create.yml
+++ b/spec/rtems/dpmem/if/create.yml
@@ -66,9 +66,9 @@ params:
dir: null
name: length
- description: |
- is the pointer to an object identifier variable. The identifier of the
- created port will be stored in this variable, in case of a successful
- operation.
+ is the pointer to an object identifier variable. When the directive call
+ is successful, the identifier of the created port will be stored in this
+ variable.
dir: out
name: id
return:
diff --git a/spec/rtems/dpmem/if/ident.yml b/spec/rtems/dpmem/if/ident.yml
index 404e4f9..b85fc84 100644
--- a/spec/rtems/dpmem/if/ident.yml
+++ b/spec/rtems/dpmem/if/ident.yml
@@ -45,9 +45,9 @@ params:
dir: null
name: name
- description: |
- is the pointer to an object identifier variable. The object identifier of
- an object with the specified name will be stored in this variable, in case
- of a successful operation.
+ 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.
dir: out
name: id
return:
diff --git a/spec/rtems/io/if/register-driver.yml b/spec/rtems/io/if/register-driver.yml
index 611e6d8..3d54eaa 100644
--- a/spec/rtems/io/if/register-driver.yml
+++ b/spec/rtems/io/if/register-driver.yml
@@ -43,9 +43,9 @@ params:
dir: null
name: driver_table
- description: |
- is the pointer to a device major number variable. The device major number
- of the registered device will be stored in this variable, in case of a
- successful operation.
+ is the pointer to a device major number variable. When the directive call
+ is successful, the device major number of the registered device will be
+ stored in this variable.
dir: out
name: registered_major
return:
diff --git a/spec/rtems/message/if/construct.yml b/spec/rtems/message/if/construct.yml
index a32dfc4..0c44794 100644
--- a/spec/rtems/message/if/construct.yml
+++ b/spec/rtems/message/if/construct.yml
@@ -55,9 +55,9 @@ params:
dir: null
name: config
- description: |
- is the pointer to an object identifier variable. The identifier of the
- constructed message queue will be stored in this variable, in case of a
- successful operation.
+ is the pointer to an object identifier variable. When the directive call
+ is successful, the identifier of the constructed message queue will be
+ stored in this variable.
dir: out
name: id
return:
diff --git a/spec/rtems/message/if/create.yml b/spec/rtems/message/if/create.yml
index 6497c71..fb388c1 100644
--- a/spec/rtems/message/if/create.yml
+++ b/spec/rtems/message/if/create.yml
@@ -118,9 +118,9 @@ params:
dir: null
name: attribute_set
- description: |
- is the pointer to an object identifier variable. The identifier of the
- created message queue will be stored in this variable, in case of a
- successful operation.
+ is the pointer to an object identifier variable. When the directive call
+ is successful, the identifier of the created message queue will be stored
+ in this variable.
dir: out
name: id
return:
diff --git a/spec/rtems/message/if/ident.yml b/spec/rtems/message/if/ident.yml
index 1c57744..0506c8e 100644
--- a/spec/rtems/message/if/ident.yml
+++ b/spec/rtems/message/if/ident.yml
@@ -71,9 +71,9 @@ params:
dir: null
name: node
- description: |
- is the pointer to an object identifier variable. The object identifier of
- an object with the specified name will be stored in this variable, in case
- of a successful operation.
+ 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.
dir: out
name: id
return:
diff --git a/spec/rtems/object/if/get-class-information.yml b/spec/rtems/object/if/get-class-information.yml
index 2530d12..37a0ca0 100644
--- a/spec/rtems/object/if/get-class-information.yml
+++ b/spec/rtems/object/if/get-class-information.yml
@@ -39,9 +39,9 @@ params:
dir: null
name: the_class
- description: |
- is the pointer to an object class information variable. The object class
- information of the class of the API will be stored in this variable, in
- case of a successful operation.
+ is the pointer to an object class information variable. When the directive
+ call is successful, the object class information of the class of the API
+ will be stored in this variable.
dir: null
name: info
return:
diff --git a/spec/rtems/object/if/get-classic-name.yml b/spec/rtems/object/if/get-classic-name.yml
index 7dfcdf7..f4a67bf 100644
--- a/spec/rtems/object/if/get-classic-name.yml
+++ b/spec/rtems/object/if/get-classic-name.yml
@@ -34,9 +34,9 @@ params:
dir: null
name: id
- description: |
- is the pointer to an object name variable. The object name associated with
- the object identifier will be stored in this variable, in case of a
- successful operation.
+ is the pointer to an object name variable. When the directive call is
+ successful, the object name associated with the object identifier will be
+ stored in this variable.
dir: out
name: name
return:
diff --git a/spec/rtems/part/if/create.yml b/spec/rtems/part/if/create.yml
index e914bd3..cf92973 100644
--- a/spec/rtems/part/if/create.yml
+++ b/spec/rtems/part/if/create.yml
@@ -114,9 +114,9 @@ params:
dir: null
name: attribute_set
- description: |
- is the pointer to an object identifier variable. The identifier of the
- created partition will be stored in this variable, in case of a successful
- operation.
+ is the pointer to an object identifier variable. When the directive call
+ is successful, the identifier of the created partition will be stored in
+ this variable.
dir: out
name: id
return:
diff --git a/spec/rtems/part/if/get-buffer.yml b/spec/rtems/part/if/get-buffer.yml
index 379e61c..736c01b 100644
--- a/spec/rtems/part/if/get-buffer.yml
+++ b/spec/rtems/part/if/get-buffer.yml
@@ -50,8 +50,9 @@ params:
dir: null
name: id
- description: |
- is the pointer to a buffer pointer variable. The pointer to the allocated
- buffer will be stored in this variable, in case of a successful operation.
+ is the pointer to a buffer pointer variable. When the directive call is
+ successful, the pointer to the allocated buffer will be stored in this
+ variable.
dir: out
name: buffer
return:
diff --git a/spec/rtems/part/if/ident.yml b/spec/rtems/part/if/ident.yml
index ca89d14..96ae159 100644
--- a/spec/rtems/part/if/ident.yml
+++ b/spec/rtems/part/if/ident.yml
@@ -73,9 +73,9 @@ params:
dir: null
name: node
- description: |
- is the pointer to an object identifier variable. The object identifier of
- an object with the specified name will be stored in this variable, in case
- of a successful operation.
+ 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.
dir: out
name: id
return:
diff --git a/spec/rtems/ratemon/if/create.yml b/spec/rtems/ratemon/if/create.yml
index abaf911..506c8ed 100644
--- a/spec/rtems/ratemon/if/create.yml
+++ b/spec/rtems/ratemon/if/create.yml
@@ -51,9 +51,9 @@ params:
dir: null
name: name
- description: |
- is the pointer to an object identifier variable. The identifier of the
- created period will be stored in this variable, in case of a successful
- operation.
+ is the pointer to an object identifier variable. When the directive call
+ is successful, the identifier of the created period will be stored in this
+ variable.
dir: out
name: id
return:
diff --git a/spec/rtems/ratemon/if/ident.yml b/spec/rtems/ratemon/if/ident.yml
index ae066fe..1cd3185 100644
--- a/spec/rtems/ratemon/if/ident.yml
+++ b/spec/rtems/ratemon/if/ident.yml
@@ -45,9 +45,9 @@ params:
dir: null
name: name
- description: |
- is the pointer to an object identifier variable. The object identifier of
- an object with the specified name will be stored in this variable, in case
- of a successful operation.
+ 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.
dir: out
name: id
return:
diff --git a/spec/rtems/region/if/create.yml b/spec/rtems/region/if/create.yml
index 572f3eb..4790e02 100644
--- a/spec/rtems/region/if/create.yml
+++ b/spec/rtems/region/if/create.yml
@@ -96,9 +96,9 @@ params:
dir: null
name: attribute_set
- description: |
- is the pointer to an object identifier variable. The identifier of the
- created region will be stored in this variable, in case of a successful
- operation.
+ is the pointer to an object identifier variable. When the directive call
+ is successful, the identifier of the created region will be stored in this
+ variable.
dir: out
name: id
return:
diff --git a/spec/rtems/region/if/ident.yml b/spec/rtems/region/if/ident.yml
index 4710f88..7a78a43 100644
--- a/spec/rtems/region/if/ident.yml
+++ b/spec/rtems/region/if/ident.yml
@@ -45,9 +45,9 @@ params:
dir: null
name: name
- description: |
- is the pointer to an object identifier variable. The object identifier of
- an object with the specified name will be stored in this variable, in case
- of a successful operation.
+ 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.
dir: out
name: id
return:
diff --git a/spec/rtems/scheduler/if/get-processor-set.yml b/spec/rtems/scheduler/if/get-processor-set.yml
index c4dfbde..8d8acb2 100644
--- a/spec/rtems/scheduler/if/get-processor-set.yml
+++ b/spec/rtems/scheduler/if/get-processor-set.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the set of processors owned by the scheduler instance.
+ Gets the set of processors owned by the scheduler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2017 On-Line Applications Research Corporation (OAR)
@@ -26,7 +26,7 @@ links:
name: rtems_scheduler_get_processor_set
notes: null
params:
-- description: is the scheduler instance identifier.
+- description: is the scheduler identifier.
dir: null
name: scheduler_id
- description: |
@@ -35,10 +35,10 @@ params:
dir: null
name: cpusetsize
- description: |
- is the pointer to a processor set variable. The processor set of the
- scheduler instance will be stored in this variable, in case of a successful
- operation. A set bit in the processor set means that the corresponding
- processor is owned by the scheduler instance, otherwise the bit is cleared.
+ is the pointer to a processor set variable. When the directive call is
+ successful, the processor set of the scheduler will be stored in this
+ variable. A set bit in the processor set means that the corresponding
+ processor is owned by the scheduler, otherwise the bit is cleared.
dir: out
name: cpuset
return:
@@ -56,6 +56,6 @@ return:
value: ${../../status/if/invalid-id:/name}
- description: |
The provided processor set was too small for the set of processors owned
- by the scheduler instance.
+ by the scheduler.
value: ${../../status/if/invalid-number:/name}
type: interface
diff --git a/spec/rtems/scheduler/if/ident-by-processor-set.yml b/spec/rtems/scheduler/if/ident-by-processor-set.yml
index 52275ca..2405320 100644
--- a/spec/rtems/scheduler/if/ident-by-processor-set.yml
+++ b/spec/rtems/scheduler/if/ident-by-processor-set.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Identifies a scheduler instance by a processor set.
+ Identifies a scheduler by a processor set.
copyrights:
- Copyright (C) 2017, 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -14,8 +14,8 @@ definition:
return: ${../../status/if/code:/name}
variants: []
description: |
- The scheduler instance is selected according to the highest numbered online
- processor in the specified processor set.
+ The scheduler is selected according to the highest numbered online processor
+ in the specified processor set.
enabled-by: true
index-entries: []
interface-type: function
@@ -34,13 +34,13 @@ params:
name: cpusetsize
- description: |
is the pointer to a processor set variable. The referenced processor set
- will be used to identify the scheduler instance.
+ will be used to identify the scheduler.
dir: null
name: cpuset
- description: |
- is the pointer to an object identifier variable. The identifier of the
- scheduler instance will be stored in this variable, in case of a successful
- operation.
+ is the pointer to an object identifier variable. When the directive call
+ is successful, the identifier of the scheduler will be stored in this
+ variable.
dir: out
name: id
return:
@@ -51,7 +51,7 @@ return:
value: ${../../status/if/successful:/name}
- description: |
The processor set was valid, however, the highest numbered online
- processor in the processor set was not owned by a scheduler instance.
+ processor in the processor set was not owned by a scheduler.
value: ${../../status/if/incorrect-state:/name}
- description: |
The ${.:/params[2]/name} parameter was ${/c/if/null:/name}.
diff --git a/spec/rtems/scheduler/if/ident-by-processor.yml b/spec/rtems/scheduler/if/ident-by-processor.yml
index 5aaa848..881155e 100644
--- a/spec/rtems/scheduler/if/ident-by-processor.yml
+++ b/spec/rtems/scheduler/if/ident-by-processor.yml
@@ -29,9 +29,9 @@ params:
dir: null
name: cpu_index
- description: |
- is the pointer to an object identifier variable. The identifier of the
- scheduler instance will be stored in this variable, in case of a successful
- operation.
+ is the pointer to an object identifier variable. When the directive call
+ is successful, the identifier of the scheduler instance will be stored in
+ this variable.
dir: out
name: id
return:
diff --git a/spec/rtems/scheduler/if/ident.yml b/spec/rtems/scheduler/if/ident.yml
index 520a7f8..328040b 100644
--- a/spec/rtems/scheduler/if/ident.yml
+++ b/spec/rtems/scheduler/if/ident.yml
@@ -39,9 +39,9 @@ params:
dir: null
name: name
- description: |
- is the pointer to an object identifier variable. The identifier of the
- scheduler instance will be stored in this variable, in case of a successful
- operation.
+ is the pointer to an object identifier variable. When the directive call
+ is successful, the identifier of the scheduler instance will be stored in
+ this variable.
dir: out
name: id
return:
diff --git a/spec/rtems/scheduler/if/map-priority-from-posix.yml b/spec/rtems/scheduler/if/map-priority-from-posix.yml
index 53274b6..1c05f44 100644
--- a/spec/rtems/scheduler/if/map-priority-from-posix.yml
+++ b/spec/rtems/scheduler/if/map-priority-from-posix.yml
@@ -25,16 +25,16 @@ links:
name: rtems_scheduler_map_priority_from_posix
notes: null
params:
-- description: is the scheduler instance identifier.
+- description: is the scheduler identifier.
dir: null
name: scheduler_id
- description: is the POSIX thread priority to map.
dir: null
name: posix_priority
- description: |
- is the pointer to a Classic API task priority variable. The Classic API
- task priority value corresponding to the specified POSIX thread priority
- value will be stored in this variable, in case of a successful operation.
+ is the pointer to a Classic API task priority variable. When the directive
+ call is successful, the Classic API task priority value corresponding to
+ the specified POSIX thread priority value will be stored in this variable.
dir: out
name: priority
return:
diff --git a/spec/rtems/scheduler/if/map-priority-to-posix.yml b/spec/rtems/scheduler/if/map-priority-to-posix.yml
index 4ca3e51..c887d45 100644
--- a/spec/rtems/scheduler/if/map-priority-to-posix.yml
+++ b/spec/rtems/scheduler/if/map-priority-to-posix.yml
@@ -32,9 +32,9 @@ params:
dir: null
name: priority
- description: |
- is the pointer to a POSIX thread priority variable. The POSIX thread
- priority value corresponding to the specified Classic API task priority
- value will be stored in this variable, in case of a successful operation.
+ is the pointer to a POSIX thread priority variable. When the directive
+ call is successful, the POSIX thread priority value corresponding to the
+ specified Classic API task priority value will be stored in this variable.
dir: out
name: posix_priority
return:
diff --git a/spec/rtems/sem/if/create.yml b/spec/rtems/sem/if/create.yml
index 10b58d4..ddffa61 100644
--- a/spec/rtems/sem/if/create.yml
+++ b/spec/rtems/sem/if/create.yml
@@ -171,9 +171,9 @@ params:
dir: null
name: priority_ceiling
- description: |
- is the pointer to an object identifier variable. The identifier of the
- created semaphore will be stored in this variable, in case of a successful
- operation.
+ is the pointer to an object identifier variable. When the directive call
+ is successful, the identifier of the created semaphore will be stored in
+ this variable.
dir: out
name: id
return:
diff --git a/spec/rtems/sem/if/ident.yml b/spec/rtems/sem/if/ident.yml
index 5b22383..5caf1be 100644
--- a/spec/rtems/sem/if/ident.yml
+++ b/spec/rtems/sem/if/ident.yml
@@ -71,9 +71,9 @@ params:
dir: null
name: node
- description: |
- is the pointer to an object identifier variable. The object identifier of
- an object with the specified name will be stored in this variable, in case
- of a successful operation.
+ 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.
dir: out
name: id
return:
diff --git a/spec/rtems/sem/if/set-priority.yml b/spec/rtems/sem/if/set-priority.yml
index 874353d..99b5694 100644
--- a/spec/rtems/sem/if/set-priority.yml
+++ b/spec/rtems/sem/if/set-priority.yml
@@ -158,9 +158,9 @@ params:
dir: null
name: new_priority
- description: |
- is the pointer to a task priority variable. The old priority of the
- semaphore corresponding to the specified scheduler will be stored in this
- variable, in case of a successful operation.
+ is the pointer to a task priority variable. When the directive call is
+ successful, the old priority of the semaphore corresponding to the
+ specified scheduler will be stored in this variable.
dir: out
name: old_priority
return:
diff --git a/spec/rtems/task/if/construct.yml b/spec/rtems/task/if/construct.yml
index cb0dda3..b0c7659 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. The identifier of the
- constructed task will be stored in this variable, in case of a successful
- operation.
+ 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.
dir: out
name: id
return:
diff --git a/spec/rtems/task/if/create.yml b/spec/rtems/task/if/create.yml
index 46da64e..3b90a86 100644
--- a/spec/rtems/task/if/create.yml
+++ b/spec/rtems/task/if/create.yml
@@ -224,9 +224,9 @@ params:
dir: null
name: attribute_set
- description: |
- is the pointer to an object identifier variable. The identifier of the
- created task will be stored in this variable, in case of a successful
- operation.
+ 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.
dir: out
name: id
return:
diff --git a/spec/rtems/task/if/ident.yml b/spec/rtems/task/if/ident.yml
index bfdfb11..b8fbf4b 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. The object identifier of
- an object with the specified name will be stored in this variable, in case
- of a successful operation.
+ 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.
dir: out
name: id
return:
diff --git a/spec/rtems/timer/if/create.yml b/spec/rtems/timer/if/create.yml
index ba8be42..e7aab89 100644
--- a/spec/rtems/timer/if/create.yml
+++ b/spec/rtems/timer/if/create.yml
@@ -50,9 +50,9 @@ params:
dir: null
name: name
- description: |
- is the pointer to an object identifier variable. The identifier of the
- created timer will be stored in this variable, in case of a successful
- operation.
+ is the pointer to an object identifier variable. When the directive call
+ is successful, the identifier of the created timer will be stored in this
+ variable.
dir: out
name: id
return:
diff --git a/spec/rtems/timer/if/get-information.yml b/spec/rtems/timer/if/get-information.yml
index a69032e..5c1c359 100644
--- a/spec/rtems/timer/if/get-information.yml
+++ b/spec/rtems/timer/if/get-information.yml
@@ -38,8 +38,9 @@ params:
dir: null
name: id
- description: |
- is the pointer to a timer information variable. The information about the
- timer will be stored in this variable, in case of a successful operation.
+ is the pointer to a timer information variable. When the directive call is
+ successful, the information about the timer will be stored in this
+ variable.
dir: out
name: the_info
return:
diff --git a/spec/rtems/timer/if/ident.yml b/spec/rtems/timer/if/ident.yml
index c99b498..3c351e2 100644
--- a/spec/rtems/timer/if/ident.yml
+++ b/spec/rtems/timer/if/ident.yml
@@ -46,9 +46,9 @@ params:
dir: null
name: name
- description: |
- is the pointer to an object identifier variable. The object identifier of
- an object with the specified name will be stored in this variable, in case
- of a successful operation.
+ 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.
dir: out
name: id
return:
diff --git a/spec/rtems/userext/if/create.yml b/spec/rtems/userext/if/create.yml
index e5bbd3a..21a4616 100644
--- a/spec/rtems/userext/if/create.yml
+++ b/spec/rtems/userext/if/create.yml
@@ -64,9 +64,9 @@ params:
dir: null
name: extension_table
- description: |
- is the pointer to an object identifier variable. The identifier of the
- created extension set will be stored in this variable, in case of a
- successful operation.
+ is the pointer to an object identifier variable. When the directive call
+ is successful, the identifier of the created extension set will be stored
+ in this variable.
dir: out
name: id
return:
diff --git a/spec/rtems/userext/if/ident.yml b/spec/rtems/userext/if/ident.yml
index 162e565..93bfdb0 100644
--- a/spec/rtems/userext/if/ident.yml
+++ b/spec/rtems/userext/if/ident.yml
@@ -46,9 +46,9 @@ params:
dir: null
name: name
- description: |
- is the pointer to an object identifier variable. The object identifier of
- an object with the specified name will be stored in this variable, in case
- of a successful operation.
+ 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.
dir: out
name: id
return:
More information about the vc
mailing list