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 | |
parent | modules: Update rtems (diff) | |
download | rtems-central-6ee44e161cdd597de8bc3614bf97d0dd2b72bbe7.tar.bz2 |
spec: Use a common phrase for pointer parameters
65 files changed, 198 insertions, 192 deletions
diff --git a/spec/c/if/timespec.yml b/spec/c/if/timespec.yml index 26775576..a1149cad 100644 --- a/spec/c/if/timespec.yml +++ b/spec/c/if/timespec.yml @@ -3,10 +3,11 @@ copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true index-entries: [] -interface-type: unspecified +interface-type: unspecified-type links: - role: interface-placement uid: sys-impl-timespec name: struct timespec -references: {} +references: + url: https://en.cppreference.com/w/c/chrono/timespec type: interface diff --git a/spec/c/if/timeval.yml b/spec/c/if/timeval.yml index 897e951c..b7d89ab4 100644 --- a/spec/c/if/timeval.yml +++ b/spec/c/if/timeval.yml @@ -3,10 +3,11 @@ copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true index-entries: [] -interface-type: unspecified +interface-type: unspecified-type links: - role: interface-placement uid: sys-impl-timeval name: struct timeval -references: {} +references: + url: https://pubs.opengroup.org/onlinepubs/009695399/basedefs/sys/time.h.html type: interface diff --git a/spec/rtems/barrier/if/create.yml b/spec/rtems/barrier/if/create.yml index 10b606e8..afa398e9 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. When the directive call + is the pointer to an ${../../type/if/id:/name} object. When the directive call is successful, the identifier of the created barrier will be stored in this - variable. + object. dir: null name: id return: diff --git a/spec/rtems/barrier/if/ident.yml b/spec/rtems/barrier/if/ident.yml index 109d82de..f03f150e 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. When the directive call + 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 variable. + will be stored in this object. dir: out name: id return: diff --git a/spec/rtems/barrier/if/release.yml b/spec/rtems/barrier/if/release.yml index 518659bd..bc7feb31 100644 --- a/spec/rtems/barrier/if/release.yml +++ b/spec/rtems/barrier/if/release.yml @@ -40,8 +40,9 @@ params: dir: null name: id - description: | - is the pointer to an integer variable. When the directive call is - successful, the number of released tasks will be stored in this variable. + is the pointer to an ${/c/if/uint32_t:/name} object. When the directive + call is successful, the number of released tasks will be stored in this + object. dir: out name: released return: diff --git a/spec/rtems/clock/if/get-seconds-since-epoch.yml b/spec/rtems/clock/if/get-seconds-since-epoch.yml index b41308fa..f6d07886 100644 --- a/spec/rtems/clock/if/get-seconds-since-epoch.yml +++ b/spec/rtems/clock/if/get-seconds-since-epoch.yml @@ -32,10 +32,10 @@ name: rtems_clock_get_seconds_since_epoch notes: null params: - description: | - is the pointer to an interval variable. When the directive call is - successful, the seconds elapsed since the ${/glossary/rtems-epoch:/term} - and the ${/glossary/clock-realtime:/term} at some point during the - directive call will be stored in this variable. + is the pointer to an ${../../type/if/interval:/name} object. When the + directive call is successful, the seconds elapsed since the + ${/glossary/rtems-epoch:/term} and the ${/glossary/clock-realtime:/term} + at some point during the directive call will be stored in this object. dir: out name: seconds_since_rtems_epoch return: diff --git a/spec/rtems/clock/if/get-tod-timeval.yml b/spec/rtems/clock/if/get-tod-timeval.yml index 01000b02..790bc10a 100644 --- a/spec/rtems/clock/if/get-tod-timeval.yml +++ b/spec/rtems/clock/if/get-tod-timeval.yml @@ -33,10 +33,10 @@ name: rtems_clock_get_tod_timeval notes: null params: - description: | - is the pointer to a timeval structure variable. When the directive call is - successful, the seconds and microseconds elapsed since the + is the pointer to a ${/c/if/timeval:/name} object. When the directive call + is successful, the seconds and microseconds elapsed since the ${/glossary/unix-epoch:/term} and the ${/glossary/clock-realtime:/term} at - some point during the directive call will be stored in this variable. + some point during the directive call will be stored in this object. dir: out name: time_of_day return: diff --git a/spec/rtems/clock/if/get-tod.yml b/spec/rtems/clock/if/get-tod.yml index 9f27617a..2bdcf21b 100644 --- a/spec/rtems/clock/if/get-tod.yml +++ b/spec/rtems/clock/if/get-tod.yml @@ -32,10 +32,10 @@ name: rtems_clock_get_tod notes: null params: - description: | - is the pointer to a RTEMS time of day variable. When the directive call is - successful, the time of day associated with the + is the pointer to an ${../../type/if/time-of-day:/name} object. When the + directive call is successful, the time of day associated with the ${/glossary/clock-realtime:/term} at some point during the directive call - will be stored in this variable. + will be stored in this object. dir: null name: time_of_day return: diff --git a/spec/rtems/clock/if/get-uptime-timeval.yml b/spec/rtems/clock/if/get-uptime-timeval.yml index f43a6bdc..1fdfeec9 100644 --- a/spec/rtems/clock/if/get-uptime-timeval.yml +++ b/spec/rtems/clock/if/get-uptime-timeval.yml @@ -32,10 +32,10 @@ name: rtems_clock_get_uptime_timeval notes: null params: - description: | - is the pointer to a timeval structure variable. The seconds and + is the pointer to a ${/c/if/timeval:/name} object. The seconds and microseconds elapsed since some time point during the system initialization and some point during the directive call using - ${/glossary/clock-monotonic:/term} will be stored in this variable. The + ${/glossary/clock-monotonic:/term} will be stored in this object. The pointer shall be valid, otherwise the behaviour is undefined. dir: out name: uptime diff --git a/spec/rtems/clock/if/get-uptime.yml b/spec/rtems/clock/if/get-uptime.yml index ebdc6138..e3561f76 100644 --- a/spec/rtems/clock/if/get-uptime.yml +++ b/spec/rtems/clock/if/get-uptime.yml @@ -32,10 +32,10 @@ name: rtems_clock_get_uptime notes: null params: - description: | - is the pointer to a timeval structure variable. When the directive call is - successful, the seconds and nanoseconds elapsed since some time point + is the pointer to a ${/c/if/timeval:/name} object. When the directive call + is successful, the seconds and nanoseconds elapsed since some time point during the system initialization and some point during the directive call - using ${/glossary/clock-monotonic:/term} will be stored in this variable. + using ${/glossary/clock-monotonic:/term} will be stored in this object. dir: out name: uptime return: diff --git a/spec/rtems/dpmem/if/create.yml b/spec/rtems/dpmem/if/create.yml index f07ec2a4..c2a7e0be 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. When the directive call - is successful, the identifier of the created port 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 port will be stored in + this object. dir: out name: id return: diff --git a/spec/rtems/dpmem/if/external-to-internal.yml b/spec/rtems/dpmem/if/external-to-internal.yml index 98112205..7570d411 100644 --- a/spec/rtems/dpmem/if/external-to-internal.yml +++ b/spec/rtems/dpmem/if/external-to-internal.yml @@ -48,9 +48,9 @@ params: dir: null name: external - description: | - is the pointer to a pointer variable. When the directive call is + is the pointer to a ``void`` pointer object. When the directive call is successful, the external address associated with the internal address will - be stored in this variable. + be stored in this object. dir: out name: internal return: diff --git a/spec/rtems/dpmem/if/ident.yml b/spec/rtems/dpmem/if/ident.yml index b85fc84a..fb9ba27d 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. 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/dpmem/if/internal-to-external.yml b/spec/rtems/dpmem/if/internal-to-external.yml index 8d0528ed..92dec8d9 100644 --- a/spec/rtems/dpmem/if/internal-to-external.yml +++ b/spec/rtems/dpmem/if/internal-to-external.yml @@ -49,9 +49,9 @@ params: dir: null name: internal - description: | - is the pointer to a pointer variable. When the directive call is + is the pointer to a ``void`` pointer object. When the directive call is successful, the external address associated with the internal address will - be stored in this variable. + be stored in this object. dir: out name: external return: diff --git a/spec/rtems/intr/if/catch.yml b/spec/rtems/intr/if/catch.yml index 14dd7feb..92a8fa96 100644 --- a/spec/rtems/intr/if/catch.yml +++ b/spec/rtems/intr/if/catch.yml @@ -55,9 +55,9 @@ params: dir: null name: vector - description: | - is the pointer to an ${isr-entry:/name} variable. When the directive call - is successful, the previous interrupt service routine established for this - interrupt vector will be stored in this variable. + is the pointer to an ${isr-entry:/name} object. When the directive call is + successful, the previous interrupt service routine established for this + interrupt vector will be stored in this object. dir: out name: old_isr_handler return: diff --git a/spec/rtems/io/if/register-driver.yml b/spec/rtems/io/if/register-driver.yml index 3d54eaaf..f4bdf392 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. When the directive call - is successful, the device major number of the registered device will be - stored in this variable. + is the pointer to an ${device-major-number:/name} object. When the + directive call is successful, the device major number of the registered + device will be stored in this object. dir: out name: registered_major return: diff --git a/spec/rtems/message/if/broadcast.yml b/spec/rtems/message/if/broadcast.yml index 8cb96b32..1dcb2ba3 100644 --- a/spec/rtems/message/if/broadcast.yml +++ b/spec/rtems/message/if/broadcast.yml @@ -58,9 +58,9 @@ params: dir: null name: size - description: | - is the pointer to an ${/c/if/uint32_t:/name} variable. When the directive + is the pointer to an ${/c/if/uint32_t:/name} object. When the directive call is successful, the number of unblocked tasks will be stored in this - variable. + object. dir: out name: count return: diff --git a/spec/rtems/message/if/construct.yml b/spec/rtems/message/if/construct.yml index 365bbc27..097d9c85 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. When the directive call - is successful, the identifier of the constructed message queue 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 message queue will be + stored in this object. dir: out name: id return: diff --git a/spec/rtems/message/if/create.yml b/spec/rtems/message/if/create.yml index fb388c1d..ca62e117 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. When the directive call - is successful, the identifier of the created message queue 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 message queue will be + stored in this object. dir: out name: id return: diff --git a/spec/rtems/message/if/flush.yml b/spec/rtems/message/if/flush.yml index 27ee2ca7..a3a5d11e 100644 --- a/spec/rtems/message/if/flush.yml +++ b/spec/rtems/message/if/flush.yml @@ -41,9 +41,9 @@ params: dir: null name: id - description: | - is the pointer to an ${/c/if/uint32_t:/name} variable. When the directive + is the pointer to an ${/c/if/uint32_t:/name} object. When the directive call is successful, the number of unblocked tasks will be stored in this - variable. + object. dir: out name: count return: diff --git a/spec/rtems/message/if/get-number-pending.yml b/spec/rtems/message/if/get-number-pending.yml index ed0fb250..16278d20 100644 --- a/spec/rtems/message/if/get-number-pending.yml +++ b/spec/rtems/message/if/get-number-pending.yml @@ -40,9 +40,9 @@ params: dir: null name: id - description: | - is the pointer to an ${/c/if/uint32_t:/name} variable. When the directive + is the pointer to an ${/c/if/uint32_t:/name} object. When the directive call is successful, the number of pending messages will be stored in this - variable. + object. dir: out name: count return: diff --git a/spec/rtems/message/if/ident.yml b/spec/rtems/message/if/ident.yml index 0506c8e9..3a2b55f0 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. 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/message/if/receive.yml b/spec/rtems/message/if/receive.yml index ac821934..57e4d127 100644 --- a/spec/rtems/message/if/receive.yml +++ b/spec/rtems/message/if/receive.yml @@ -96,11 +96,11 @@ params: dir: null name: buffer - description: | - is the pointer to a ${/c/if/size_t:/name} variable. When the directive - call is successful, the size in bytes of the received messages will be - stored in this variable. This parameter cannot be used to specify the size - of the buffer. - dir: null + is the pointer to a ${/c/if/size_t:/name} object. When the directive call + is successful, the size in bytes of the received messages will be stored in + this object. This parameter cannot be used to specify the size of the + buffer. + dir: out name: size - description: | is the option set. diff --git a/spec/rtems/object/if/get-class-information.yml b/spec/rtems/object/if/get-class-information.yml index 37a0ca01..29ccbd84 100644 --- a/spec/rtems/object/if/get-class-information.yml +++ b/spec/rtems/object/if/get-class-information.yml @@ -39,10 +39,10 @@ params: dir: null name: the_class - description: | - 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 + is the pointer to an ${api-class-information:/name} object. When the + directive call is successful, the object class information of the class of + the API will be stored in this object. + dir: out name: info return: return: null diff --git a/spec/rtems/object/if/get-classic-name.yml b/spec/rtems/object/if/get-classic-name.yml index f4a67bf0..5e59534e 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. When the directive call is - successful, the object name associated with the object identifier will be - stored in this variable. + is the pointer to an ${../../type/if/name:/name} object. When the + directive call is successful, the object name associated with the object + identifier will be stored in this object. dir: out name: name return: diff --git a/spec/rtems/part/if/create.yml b/spec/rtems/part/if/create.yml index cf92973c..5416debd 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. When the directive call - is successful, the identifier of the created partition 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 partition will be stored + in this object. dir: out name: id return: diff --git a/spec/rtems/part/if/get-buffer.yml b/spec/rtems/part/if/get-buffer.yml index 736c01b3..d5b2c8ec 100644 --- a/spec/rtems/part/if/get-buffer.yml +++ b/spec/rtems/part/if/get-buffer.yml @@ -50,9 +50,9 @@ params: dir: null name: id - description: | - is the pointer to a buffer pointer variable. When the directive call is + is the pointer to a ``void`` pointer object. When the directive call is successful, the pointer to the allocated buffer will be stored in this - variable. + object. dir: out name: buffer return: diff --git a/spec/rtems/part/if/ident.yml b/spec/rtems/part/if/ident.yml index 96ae159d..5b5e5620 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. 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/ratemon/if/create.yml b/spec/rtems/ratemon/if/create.yml index 506c8edc..4ffea875 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. When the directive call - is successful, the identifier of the created period 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 period will be stored in + this object. dir: out name: id return: diff --git a/spec/rtems/ratemon/if/get-statistics.yml b/spec/rtems/ratemon/if/get-statistics.yml index ea2bab31..167204ac 100644 --- a/spec/rtems/ratemon/if/get-statistics.yml +++ b/spec/rtems/ratemon/if/get-statistics.yml @@ -64,9 +64,8 @@ params: dir: null name: id - description: | - is the pointer to a ${period-statistics:/name} variable. When the - directive call is successful, the period statistics will be stored in this - variable. + is the pointer to an ${period-statistics:/name} object. When the directive + call is successful, the period statistics will be stored in this object. dir: out name: status return: diff --git a/spec/rtems/ratemon/if/get-status.yml b/spec/rtems/ratemon/if/get-status.yml index 56684d05..e6561c76 100644 --- a/spec/rtems/ratemon/if/get-status.yml +++ b/spec/rtems/ratemon/if/get-status.yml @@ -60,9 +60,9 @@ params: dir: null name: id - description: | - is the pointer to a ${period-status:/name} variable. When the directive + is the pointer to an ${period-status:/name} object. When the directive call is successful, the detailed period status will be stored in this - variable. + object. dir: out name: status return: diff --git a/spec/rtems/ratemon/if/ident.yml b/spec/rtems/ratemon/if/ident.yml index 1cd3185b..c28c32f5 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. 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/region/if/create.yml b/spec/rtems/region/if/create.yml index 20992cd7..4ef9f080 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. When the directive call - is successful, the identifier of the created region 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 region will be stored in + this object. dir: out name: id return: diff --git a/spec/rtems/region/if/get-free-information.yml b/spec/rtems/region/if/get-free-information.yml index 92f562fa..2cc76094 100644 --- a/spec/rtems/region/if/get-free-information.yml +++ b/spec/rtems/region/if/get-free-information.yml @@ -51,9 +51,9 @@ params: dir: null name: id - description: | - is the pointer to a ${/score/heap/if/information-block:/name} variable. - When the directive call is successful, the free information of the region - will be stored in this variable. + is the pointer to a ${/score/heap/if/information-block:/name} object. When + the directive call is successful, the free information of the region will + be stored in this object. dir: out name: the_info return: diff --git a/spec/rtems/region/if/get-information.yml b/spec/rtems/region/if/get-information.yml index e48cb4cc..a30767c0 100644 --- a/spec/rtems/region/if/get-information.yml +++ b/spec/rtems/region/if/get-information.yml @@ -49,9 +49,9 @@ params: dir: null name: id - description: | - is the pointer to a ${/score/heap/if/information-block:/name} variable. - When the directive call is successful, the information of the region will - be stored in this variable. + is the pointer to a ${/score/heap/if/information-block:/name} object. When + the directive call is successful, the information of the region will be + stored in this object. dir: out name: the_info return: diff --git a/spec/rtems/region/if/get-segment-size.yml b/spec/rtems/region/if/get-segment-size.yml index ca434ef5..0d961c6d 100644 --- a/spec/rtems/region/if/get-segment-size.yml +++ b/spec/rtems/region/if/get-segment-size.yml @@ -47,9 +47,9 @@ params: dir: null name: segment - description: | - is the pointer to a ${/c/if/uintptr_t:/name} variable. When the directive + is the pointer to a ${/c/if/uintptr_t:/name} object. When the directive call is successful, the size of the segment in bytes will be stored in this - variable. + object. dir: out name: size return: diff --git a/spec/rtems/region/if/get-segment.yml b/spec/rtems/region/if/get-segment.yml index 61fb0168..b6a52262 100644 --- a/spec/rtems/region/if/get-segment.yml +++ b/spec/rtems/region/if/get-segment.yml @@ -101,11 +101,10 @@ params: dir: null name: timeout - description: | - is the pointer to a void pointer variable. When the directive call is + is the pointer to a ``void`` pointer object. When the directive call is successful, the begin address of the allocated segment will be stored in - this variable. + this object. dir: out - dir: null name: segment return: return: null diff --git a/spec/rtems/region/if/ident.yml b/spec/rtems/region/if/ident.yml index 7a78a43c..a0e6935d 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. 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/region/if/resize-segment.yml b/spec/rtems/region/if/resize-segment.yml index 396d2bca..14c51b0c 100644 --- a/spec/rtems/region/if/resize-segment.yml +++ b/spec/rtems/region/if/resize-segment.yml @@ -56,9 +56,9 @@ params: dir: null name: size - description: | - is the pointer to an ${/c/if/uintptr_t:/name} variable. When the directive + is the pointer to an ${/c/if/uintptr_t:/name} object. When the directive call is successful, the old size of the segment will be stored in this - variable. + object. dir: out name: old_size return: diff --git a/spec/rtems/scheduler/if/get-maximum-priority.yml b/spec/rtems/scheduler/if/get-maximum-priority.yml index f1517c45..c58ccb90 100644 --- a/spec/rtems/scheduler/if/get-maximum-priority.yml +++ b/spec/rtems/scheduler/if/get-maximum-priority.yml @@ -33,9 +33,9 @@ params: dir: null name: scheduler_id - description: | - is the pointer to a task priority variable. The maximum priority of the - scheduler will be stored in this variable, if the operation is - successful. + is the pointer to an ${../../type/if/priority:/name} object. When the + directive the maximum priority of the scheduler will be stored in this + object. dir: out name: priority return: diff --git a/spec/rtems/scheduler/if/get-processor-set.yml b/spec/rtems/scheduler/if/get-processor-set.yml index fdff5d86..cdc514b4 100644 --- a/spec/rtems/scheduler/if/get-processor-set.yml +++ b/spec/rtems/scheduler/if/get-processor-set.yml @@ -35,13 +35,14 @@ params: dir: null name: scheduler_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 set of the scheduler will be stored in this - variable. A set bit in the processor set means that the corresponding + is the pointer to a ${/c/if/cpu_set_t:/name} object. When the directive + call is successful, the processor set of the scheduler will be stored in + this object. 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 diff --git a/spec/rtems/scheduler/if/ident-by-processor-set.yml b/spec/rtems/scheduler/if/ident-by-processor-set.yml index 426857ad..c6d88201 100644 --- a/spec/rtems/scheduler/if/ident-by-processor-set.yml +++ b/spec/rtems/scheduler/if/ident-by-processor-set.yml @@ -32,19 +32,19 @@ name: rtems_scheduler_ident_by_processor_set notes: null params: - description: | - is the size of the referenced processor set variable in bytes. This value - shall be positive. + is the size of the processor set referenced by ${.:/params[1]/name} in + bytes. The size shall be positive. dir: null name: cpusetsize - description: | - is the pointer to a processor set variable. The referenced processor set + is the pointer to a ${/c/if/cpu_set_t:/name}. The referenced processor set will be used to identify the scheduler. dir: null name: cpuset - description: | - is the pointer to an object identifier variable. When the directive call + is the pointer to an ${../../type/if/id:/name} object. When the directive call is successful, the identifier of the scheduler will be stored in this - variable. + object. dir: out name: id return: diff --git a/spec/rtems/scheduler/if/ident-by-processor.yml b/spec/rtems/scheduler/if/ident-by-processor.yml index cad616ab..ae1dafc9 100644 --- a/spec/rtems/scheduler/if/ident-by-processor.yml +++ b/spec/rtems/scheduler/if/ident-by-processor.yml @@ -33,9 +33,9 @@ params: dir: null name: cpu_index - description: | - 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. + is the pointer to an ${../../type/if/id:/name} object. When the directive + call is successful, the identifier of the scheduler will be stored in this + object. dir: out name: id return: diff --git a/spec/rtems/scheduler/if/ident.yml b/spec/rtems/scheduler/if/ident.yml index c7dfb1e7..159faf8e 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. When the directive call - is successful, the identifier of the scheduler 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 scheduler will be stored in this + object. 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 e6d06f3f..70d9479e 100644 --- a/spec/rtems/scheduler/if/map-priority-from-posix.yml +++ b/spec/rtems/scheduler/if/map-priority-from-posix.yml @@ -38,9 +38,10 @@ params: dir: null name: posix_priority - description: | - 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. + is the pointer to an ${../../type/if/priority:/name} object. 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 object. 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 3a987368..c1b65e6a 100644 --- a/spec/rtems/scheduler/if/map-priority-to-posix.yml +++ b/spec/rtems/scheduler/if/map-priority-to-posix.yml @@ -38,9 +38,9 @@ params: dir: null name: priority - description: | - 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. + is the pointer to an ``int`` object. 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 object. dir: out name: posix_priority return: diff --git a/spec/rtems/sem/if/create.yml b/spec/rtems/sem/if/create.yml index e16db848..dc1c76cb 100644 --- a/spec/rtems/sem/if/create.yml +++ b/spec/rtems/sem/if/create.yml @@ -169,9 +169,9 @@ params: dir: null name: priority_ceiling - description: | - 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. + is the pointer to an ${../../type/if/id:/name} object. When the directive + call is successful, the identifier of the created semaphore will be stored + in this object. dir: out name: id return: diff --git a/spec/rtems/sem/if/ident.yml b/spec/rtems/sem/if/ident.yml index 5caf1bea..79399f6b 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. 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/sem/if/set-priority.yml b/spec/rtems/sem/if/set-priority.yml index 3b5569a8..5d796d82 100644 --- a/spec/rtems/sem/if/set-priority.yml +++ b/spec/rtems/sem/if/set-priority.yml @@ -159,9 +159,9 @@ params: dir: null name: new_priority - description: | - 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. + is the pointer to an ${../../type/if/priority:/name} object. When the + directive call is successful, the old priority of the semaphore + corresponding to the specified scheduler will be stored in this object. dir: out name: old_priority return: diff --git a/spec/rtems/support/if/workspace-allocate.yml b/spec/rtems/support/if/workspace-allocate.yml index feb84b40..422e03d4 100644 --- a/spec/rtems/support/if/workspace-allocate.yml +++ b/spec/rtems/support/if/workspace-allocate.yml @@ -37,9 +37,9 @@ params: dir: null name: bytes - description: | - is the pointer to a pointer variable. When the directive call is + is the pointer to a ``void`` pointer object. When the directive call is successful, the begin address of the allocated memory area will be stored - in this variable. + in this object. dir: out name: pointer return: diff --git a/spec/rtems/support/if/workspace-get-information.yml b/spec/rtems/support/if/workspace-get-information.yml index 16253854..16317143 100644 --- a/spec/rtems/support/if/workspace-get-information.yml +++ b/spec/rtems/support/if/workspace-get-information.yml @@ -31,9 +31,10 @@ name: rtems_workspace_get_information notes: null params: - description: | - is the pointer to a heap information variable. When the directive call is - successful, the heap information will be stored in this variable. - dir: null + is the pointer to a ${/score/heap/if/information-block:/name} object. When + the directive call is successful, the heap information will be stored in + this object. + dir: out name: the_info return: return: | 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: diff --git a/spec/rtems/timer/if/create.yml b/spec/rtems/timer/if/create.yml index e7aab890..dc36183d 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. When the directive call - is successful, the identifier of the created timer 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 timer will be stored in + this object. dir: out name: id return: diff --git a/spec/rtems/timer/if/get-information.yml b/spec/rtems/timer/if/get-information.yml index 5c1c3597..8fe4e0ee 100644 --- a/spec/rtems/timer/if/get-information.yml +++ b/spec/rtems/timer/if/get-information.yml @@ -38,9 +38,9 @@ params: dir: null name: id - description: | - 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. + is the pointer to an ${information:/name} object. When the directive call + is successful, the information about the timer will be stored in this + object. dir: out name: the_info return: diff --git a/spec/rtems/timer/if/ident.yml b/spec/rtems/timer/if/ident.yml index 3c351e2d..0a49c097 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. 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/userext/if/create.yml b/spec/rtems/userext/if/create.yml index 21a46165..f4f25323 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. When the directive call - is successful, the identifier of the created extension set 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 extension set will be + stored in this object. dir: out name: id return: diff --git a/spec/rtems/userext/if/ident.yml b/spec/rtems/userext/if/ident.yml index 93bfdb0c..d777e0fc 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. 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: |