[PATCH] c-user: Use a common phrase for pointer parameters
Gedare Bloom
gedare at rtems.org
Mon Jun 14 14:54:13 UTC 2021
ok.
On Mon, Jun 14, 2021 at 1:20 AM Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
>
> Mention the type of the pointer in the parameter description. Use the
> more general term "object" instead of "variable".
>
> Update #3993.
> ---
> c-user/barrier/directives.rst | 15 +++----
> c-user/clock/directives.rst | 44 +++++++++++---------
> c-user/dual-ported-memory/directives.rst | 20 ++++-----
> c-user/interrupt/directives.rst | 7 ++--
> c-user/io/directives.rst | 6 +--
> c-user/message/directives.rst | 28 ++++++-------
> c-user/object-services/directives.rst | 11 ++---
> c-user/partition/directives.rst | 12 +++---
> c-user/rate-monotonic/directives.rst | 20 ++++-----
> c-user/region/directives.rst | 32 +++++++--------
> c-user/scheduling-concepts/directives.rst | 41 +++++++++----------
> c-user/semaphore/directives.rst | 14 +++----
> c-user/task/directives.rst | 50 +++++++++++------------
> c-user/timer/directives.rst | 14 +++----
> c-user/user-extensions/directives.rst | 8 ++--
> 15 files changed, 163 insertions(+), 159 deletions(-)
>
> diff --git a/c-user/barrier/directives.rst b/c-user/barrier/directives.rst
> index ec40844..59abc51 100644
> --- a/c-user/barrier/directives.rst
> +++ b/c-user/barrier/directives.rst
> @@ -67,9 +67,9 @@ Creates a barrier.
> barrier.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the created barrier will be
> - stored in this variable.
> + stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -175,9 +175,9 @@ Identifies a barrier by the object name.
> This parameter is the object name to look up.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the object identifier of an object with the
> - specified name will be stored in this variable.
> + specified name will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -380,9 +380,10 @@ Releases the barrier.
> This parameter is the barrier identifier.
>
> ``released``
> - This parameter is the pointer to an integer variable. When the directive
> - call is successful, the number of released tasks will be stored in this
> - variable.
> + This parameter is the pointer to an `uint32_t
> + <https://en.cppreference.com/w/c/types/integer>`_ object. When the
> + directive call is successful, the number of released tasks will be stored
> + in this object.
>
> .. rubric:: DESCRIPTION:
>
> diff --git a/c-user/clock/directives.rst b/c-user/clock/directives.rst
> index 4ed1c58..e0f858a 100644
> --- a/c-user/clock/directives.rst
> +++ b/c-user/clock/directives.rst
> @@ -126,10 +126,10 @@ Gets the time of day associated with the current :term:`CLOCK_REALTIME`.
> .. rubric:: PARAMETERS:
>
> ``time_of_day``
> - This parameter is the pointer to a RTEMS time of day variable. When the
> - directive call is successful, the time of day associated with the
> + This parameter is the pointer to an :c:type:`rtems_time_of_day` object.
> + When the directive call is successful, the time of day associated with the
> :term:`CLOCK_REALTIME` at some point during the directive call will be
> - stored in this variable.
> + stored in this object.
>
> .. rubric:: RETURN VALUES:
>
> @@ -179,10 +179,12 @@ current :term:`CLOCK_REALTIME`.
> .. rubric:: PARAMETERS:
>
> ``time_of_day``
> - This parameter is the pointer to a timeval structure variable. When the
> - directive call is successful, the seconds and microseconds elapsed since
> - the :term:`Unix epoch` and the :term:`CLOCK_REALTIME` at some point during
> - the directive call will be stored in this variable.
> + This parameter is the pointer to a `struct timeval
> + <https://pubs.opengroup.org/onlinepubs/009695399/basedefs/sys/time.h.html>`_
> + object. When the directive call is successful, the seconds and
> + microseconds elapsed since the :term:`Unix epoch` and the
> + :term:`CLOCK_REALTIME` at some point during the directive call will be
> + stored in this object.
>
> .. rubric:: RETURN VALUES:
>
> @@ -234,10 +236,10 @@ Gets the seconds elapsed since the :term:`RTEMS epoch` and the current
> .. rubric:: PARAMETERS:
>
> ``seconds_since_rtems_epoch``
> - This parameter is the pointer to an interval variable. When the directive
> - call is successful, the seconds elapsed since the :term:`RTEMS epoch` and
> - the :term:`CLOCK_REALTIME` at some point during the directive call will be
> - stored in this variable.
> + This parameter is the pointer to an :c:type:`rtems_interval` object. When
> + the directive call is successful, the seconds elapsed since the
> + :term:`RTEMS epoch` and the :term:`CLOCK_REALTIME` at some point during the
> + directive call will be stored in this object.
>
> .. rubric:: RETURN VALUES:
>
> @@ -370,11 +372,12 @@ system initialization using :term:`CLOCK_MONOTONIC`.
> .. rubric:: PARAMETERS:
>
> ``uptime``
> - This parameter is the pointer to a timeval structure variable. 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 :term:`CLOCK_MONOTONIC` will be stored in this
> - variable.
> + This parameter is the pointer to a `struct timeval
> + <https://pubs.opengroup.org/onlinepubs/009695399/basedefs/sys/time.h.html>`_
> + 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 :term:`CLOCK_MONOTONIC` will be
> + stored in this object.
>
> .. rubric:: RETURN VALUES:
>
> @@ -420,10 +423,11 @@ system initialization using :term:`CLOCK_MONOTONIC`.
> .. rubric:: PARAMETERS:
>
> ``uptime``
> - This parameter is the pointer to a timeval structure variable. The seconds
> - and microseconds elapsed since some time point during the system
> - initialization and some point during the directive call using
> - :term:`CLOCK_MONOTONIC` will be stored in this variable. The pointer shall
> + This parameter is the pointer to a `struct timeval
> + <https://pubs.opengroup.org/onlinepubs/009695399/basedefs/sys/time.h.html>`_
> + object. The seconds and microseconds elapsed since some time point during
> + the system initialization and some point during the directive call using
> + :term:`CLOCK_MONOTONIC` will be stored in this object. The pointer shall
> be valid, otherwise the behaviour is undefined.
>
> .. rubric:: CONSTRAINTS:
> diff --git a/c-user/dual-ported-memory/directives.rst b/c-user/dual-ported-memory/directives.rst
> index 42cb875..869fd4b 100644
> --- a/c-user/dual-ported-memory/directives.rst
> +++ b/c-user/dual-ported-memory/directives.rst
> @@ -71,9 +71,9 @@ Creates a port.
> This parameter is the length in bytes of the memory area.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the created port will be
> - stored in this variable.
> + stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -158,9 +158,9 @@ Identifies a port by the object name.
> This parameter is the object name to look up.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the object identifier of an object with the
> - specified name will be stored in this variable.
> + specified name will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -297,9 +297,9 @@ Converts the external address to the internal address.
> This parameter is the external address to convert.
>
> ``internal``
> - This parameter is the pointer to a pointer variable. When the directive
> - call is successful, the external address associated with the internal
> - address will be stored in this variable.
> + This parameter 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 object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -367,9 +367,9 @@ Converts the internal address to the external address.
> This parameter is the internal address to convert.
>
> ``external``
> - This parameter is the pointer to a pointer variable. When the directive
> - call is successful, the external address associated with the internal
> - address will be stored in this variable.
> + This parameter 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 object.
>
> .. rubric:: DESCRIPTION:
>
> diff --git a/c-user/interrupt/directives.rst b/c-user/interrupt/directives.rst
> index 2b15fd6..f3a944d 100644
> --- a/c-user/interrupt/directives.rst
> +++ b/c-user/interrupt/directives.rst
> @@ -63,10 +63,9 @@ Establishes an interrupt service routine.
> This parameter is the interrupt vector number.
>
> ``old_isr_handler``
> - This parameter is the pointer to an :c:type:`rtems_isr_entry` variable.
> - When the directive call is successful, the previous interrupt service
> - routine established for this interrupt vector will be stored in this
> - variable.
> + This parameter is the pointer to an :c:type:`rtems_isr_entry` object. When
> + the directive call is successful, the previous interrupt service routine
> + established for this interrupt vector will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> diff --git a/c-user/io/directives.rst b/c-user/io/directives.rst
> index 0683c4c..d308944 100644
> --- a/c-user/io/directives.rst
> +++ b/c-user/io/directives.rst
> @@ -64,9 +64,9 @@ table and device major number in the Device Driver Table.
> This parameter is the device driver address table.
>
> ``registered_major``
> - This parameter 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.
> + This parameter is the pointer to an :c:type:`rtems_device_major_number`
> + object. When the directive call is successful, the device major number of
> + the registered device will be stored in this object.
>
> .. rubric:: RETURN VALUES:
>
> diff --git a/c-user/message/directives.rst b/c-user/message/directives.rst
> index 11ff105..f320350 100644
> --- a/c-user/message/directives.rst
> +++ b/c-user/message/directives.rst
> @@ -72,9 +72,9 @@ Creates a message queue.
> This parameter is the attribute set of the message queue.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the created message queue
> - will be stored in this variable.
> + will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -233,9 +233,9 @@ Constructs a message queue from the specified the message queue configuration.
> This parameter is the message queue configuration.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the constructed message
> - queue will be stored in this variable.
> + queue will be stored in this object.
>
> .. rubric:: RETURN VALUES:
>
> @@ -361,9 +361,9 @@ Identifies a message queue by the object name.
> This parameter is the node or node set to search for a matching object.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the object identifier of an object with the
> - specified name will be stored in this variable.
> + specified name will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -719,9 +719,9 @@ Broadcasts the messages to the tasks waiting at the queue.
>
> ``count``
> This parameter is the pointer to an `uint32_t
> - <https://en.cppreference.com/w/c/types/integer>`_ variable. When the
> + <https://en.cppreference.com/w/c/types/integer>`_ object. When the
> directive call is successful, the number of unblocked tasks will be stored
> - in this variable.
> + in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -815,9 +815,9 @@ Receives a message from the queue.
>
> ``size``
> This parameter is the pointer to a `size_t
> - <https://en.cppreference.com/w/c/types/size_t>`_ variable. When the
> + <https://en.cppreference.com/w/c/types/size_t>`_ object. 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
> + will be stored in this object. This parameter cannot be used to specify
> the size of the buffer.
>
> ``option_set``
> @@ -954,9 +954,9 @@ Gets the number of messages pending on the queue.
>
> ``count``
> This parameter is the pointer to an `uint32_t
> - <https://en.cppreference.com/w/c/types/integer>`_ variable. When the
> + <https://en.cppreference.com/w/c/types/integer>`_ object. When the
> directive call is successful, the number of pending messages will be stored
> - in this variable.
> + in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -1017,9 +1017,9 @@ Flushes all messages on the queue.
>
> ``count``
> This parameter is the pointer to an `uint32_t
> - <https://en.cppreference.com/w/c/types/integer>`_ variable. When the
> + <https://en.cppreference.com/w/c/types/integer>`_ object. When the
> directive call is successful, the number of unblocked tasks will be stored
> - in this variable.
> + in this object.
>
> .. rubric:: DESCRIPTION:
>
> diff --git a/c-user/object-services/directives.rst b/c-user/object-services/directives.rst
> index 54f234f..c975c75 100644
> --- a/c-user/object-services/directives.rst
> +++ b/c-user/object-services/directives.rst
> @@ -168,9 +168,9 @@ Gets the object name associated with the object identifier.
> This parameter is the object identifier to get the name.
>
> ``name``
> - This parameter is the pointer to an object name variable. When the
> + This parameter is the pointer to an :c:type:`rtems_name` object. When the
> directive call is successful, the object name associated with the object
> - identifier will be stored in this variable.
> + identifier will be stored in this object.
>
> .. rubric:: RETURN VALUES:
>
> @@ -801,9 +801,10 @@ Gets the object class information of the object class of the object API.
> information.
>
> ``info``
> - This parameter 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.
> + This parameter is the pointer to an
> + :c:type:`rtems_object_api_class_information` object. When the directive
> + call is successful, the object class information of the class of the API
> + will be stored in this object.
>
> .. rubric:: RETURN VALUES:
>
> diff --git a/c-user/partition/directives.rst b/c-user/partition/directives.rst
> index 98c0eb1..534cfb4 100644
> --- a/c-user/partition/directives.rst
> +++ b/c-user/partition/directives.rst
> @@ -76,9 +76,9 @@ Creates a partition.
> This parameter is the attribute set of the partition.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the created partition will
> - be stored in this variable.
> + be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -241,9 +241,9 @@ Identifies a partition by the object name.
> This parameter is the node or node set to search for a matching object.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the object identifier of an object with the
> - specified name will be stored in this variable.
> + specified name will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -415,9 +415,9 @@ Tries to get a buffer from the partition.
> This parameter is the partition identifier.
>
> ``buffer``
> - This parameter is the pointer to a buffer pointer variable. When the
> + This parameter 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.
> + stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> diff --git a/c-user/rate-monotonic/directives.rst b/c-user/rate-monotonic/directives.rst
> index 1935e8a..02b8898 100644
> --- a/c-user/rate-monotonic/directives.rst
> +++ b/c-user/rate-monotonic/directives.rst
> @@ -56,9 +56,9 @@ Creates a period.
> This parameter is the object name of the period.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the created period will be
> - stored in this variable.
> + stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -133,9 +133,9 @@ Identifies a period by the object name.
> This parameter is the object name to look up.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the object identifier of an object with the
> - specified name will be stored in this variable.
> + specified name will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -407,10 +407,10 @@ Gets the detailed status of the period.
> This parameter is the rate monotonic period identifier.
>
> ``status``
> - This parameter is the pointer to a
> - :c:type:`rtems_rate_monotonic_period_status` variable. When the directive
> + This parameter is the pointer to an
> + :c:type:`rtems_rate_monotonic_period_status` object. When the directive
> call is successful, the detailed period status will be stored in this
> - variable.
> + object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -494,10 +494,10 @@ Gets the statistics of the period.
> This parameter is the rate monotonic period identifier.
>
> ``status``
> - This parameter is the pointer to a
> - :c:type:`rtems_rate_monotonic_period_statistics` variable. When the
> + This parameter is the pointer to an
> + :c:type:`rtems_rate_monotonic_period_statistics` object. When the
> directive call is successful, the period statistics will be stored in this
> - variable.
> + object.
>
> .. rubric:: DESCRIPTION:
>
> diff --git a/c-user/region/directives.rst b/c-user/region/directives.rst
> index 86bb537..5a03e6a 100644
> --- a/c-user/region/directives.rst
> +++ b/c-user/region/directives.rst
> @@ -77,9 +77,9 @@ Creates a region.
> This parameter is the attribute set of the region.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the created region will be
> - stored in this variable.
> + stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -193,9 +193,9 @@ Identifies a region by the object name.
> This parameter is the object name to look up.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the object identifier of an object with the
> - specified name will be stored in this variable.
> + specified name will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -427,9 +427,9 @@ Gets a segment from the region.
> wait potentially forever.
>
> ``segment``
> - This parameter is the pointer to a void pointer variable. When the
> + This parameter 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.
> + will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -635,9 +635,9 @@ Changes the size of the segment.
>
> ``old_size``
> This parameter is the pointer to an `uintptr_t
> - <https://en.cppreference.com/w/c/types/integer>`_ variable. When the
> + <https://en.cppreference.com/w/c/types/integer>`_ object. When the
> directive call is successful, the old size of the segment will be stored in
> - this variable.
> + this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -713,9 +713,9 @@ Gets the region information.
> This parameter is the region identifier.
>
> ``the_info``
> - This parameter is the pointer to a Heap_Information_block variable. When
> - the directive call is successful, the information of the region will be
> - stored in this variable.
> + This parameter is the pointer to a Heap_Information_block object. When the
> + directive call is successful, the information of the region will be stored
> + in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -788,9 +788,9 @@ Gets the region free information.
> This parameter is the region identifier.
>
> ``the_info``
> - This parameter is the pointer to a Heap_Information_block variable. When
> - the directive call is successful, the free information of the region will
> - be stored in this variable.
> + This parameter is the pointer to a Heap_Information_block object. When the
> + directive call is successful, the free information of the region will be
> + stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -871,9 +871,9 @@ Gets the size of the region segment.
>
> ``size``
> This parameter is the pointer to a `uintptr_t
> - <https://en.cppreference.com/w/c/types/integer>`_ variable. When the
> + <https://en.cppreference.com/w/c/types/integer>`_ object. When the
> directive call is successful, the size of the segment in bytes will be
> - stored in this variable.
> + stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> diff --git a/c-user/scheduling-concepts/directives.rst b/c-user/scheduling-concepts/directives.rst
> index 4785457..aa0300e 100644
> --- a/c-user/scheduling-concepts/directives.rst
> +++ b/c-user/scheduling-concepts/directives.rst
> @@ -54,9 +54,9 @@ Identifies a scheduler by the object name.
> This parameter is the scheduler name to look up.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the scheduler will be
> - stored in this variable.
> + stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -120,9 +120,9 @@ Identifies a scheduler by the processor index.
> This parameter is the processor index to identify the scheduler.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the scheduler will be
> - stored in this variable.
> + stored in this object.
>
> .. rubric:: RETURN VALUES:
>
> @@ -176,17 +176,17 @@ Identifies a scheduler by the processor set.
> .. rubric:: PARAMETERS:
>
> ``cpusetsize``
> - This parameter is the size of the referenced processor set variable in
> - bytes. This value shall be positive.
> + This parameter is the size of the processor set referenced by ``cpuset`` in
> + bytes. The size shall be positive.
>
> ``cpuset``
> - This parameter is the pointer to a processor set variable. The referenced
> + This parameter is the pointer to a :c:type:`cpu_set_t`. The referenced
> processor set will be used to identify the scheduler.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the scheduler will be
> - stored in this variable.
> + stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -254,9 +254,9 @@ Gets the maximum task priority of the scheduler.
> This parameter is the scheduler identifier.
>
> ``priority``
> - This parameter 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.
> + This parameter is the pointer to an :c:type:`rtems_task_priority` object.
> + When the directive the maximum priority of the scheduler will be stored in
> + this object.
>
> .. rubric:: RETURN VALUES:
>
> @@ -313,10 +313,9 @@ Maps a Classic API task priority to the corresponding POSIX thread priority.
> This parameter is the Classic API task priority to map.
>
> ``posix_priority``
> - This parameter 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.
> + This parameter 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.
>
> .. rubric:: RETURN VALUES:
>
> @@ -376,10 +375,10 @@ Maps a POSIX thread priority to the corresponding Classic API task priority.
> This parameter is the POSIX thread priority to map.
>
> ``priority``
> - This parameter is the pointer to a Classic API task priority variable.
> + This parameter is the pointer to an :c:type:`rtems_task_priority` 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 variable.
> + in this object.
>
> .. rubric:: RETURN VALUES:
>
> @@ -532,13 +531,13 @@ Gets the set of processors owned by the scheduler.
> This parameter is the scheduler identifier.
>
> ``cpusetsize``
> - This parameter is the size of the referenced processor set variable in
> + This parameter is the size of the processor set referenced by ``cpuset`` in
> bytes.
>
> ``cpuset``
> - This parameter is the pointer to a processor set variable. When the
> + This parameter is the pointer to a :c:type:`cpu_set_t` object. 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
> + 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.
>
> diff --git a/c-user/semaphore/directives.rst b/c-user/semaphore/directives.rst
> index 45ed8c1..5a66ac1 100644
> --- a/c-user/semaphore/directives.rst
> +++ b/c-user/semaphore/directives.rst
> @@ -75,9 +75,9 @@ Creates a semaphore.
> the attribute set.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the created semaphore will
> - be stored in this variable.
> + be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -278,9 +278,9 @@ Identifies a semaphore by the object name.
> This parameter is the node or node set to search for a matching object.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the object identifier of an object with the
> - specified name will be stored in this variable.
> + specified name will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -862,9 +862,9 @@ Sets the priority by scheduler for the semaphore.
> scheduler.
>
> ``old_priority``
> - This parameter 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.
> + This parameter is the pointer to an :c:type:`rtems_task_priority` object.
> + When the directive call is successful, the old priority of the semaphore
> + corresponding to the specified scheduler will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> diff --git a/c-user/task/directives.rst b/c-user/task/directives.rst
> index 47e51d1..e544525 100644
> --- a/c-user/task/directives.rst
> +++ b/c-user/task/directives.rst
> @@ -74,9 +74,9 @@ Creates a task.
> This parameter is the attribute set of the task.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the created task will be
> - stored in this variable.
> + stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -335,9 +335,9 @@ Constructs a task from the specified task configuration.
> This parameter is the task configuration.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the constructed task will
> - be stored in this variable.
> + be stored in this object.
>
> .. rubric:: RETURN VALUES:
>
> @@ -475,9 +475,9 @@ Identifies a task by the object name.
> This parameter is the node or node set to search for a matching object.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the object identifier of an object with the
> - specified name will be stored in this variable.
> + specified name will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -1147,10 +1147,10 @@ Sets the real priority or gets the current priority of the task.
> :c:macro:`RTEMS_CURRENT_PRIORITY` to get the current priority.
>
> ``old_priority``
> - This parameter is the pointer to an :c:type:`rtems_task_priority` variable.
> + This parameter is the pointer to an :c:type:`rtems_task_priority` object.
> When the directive call is successful, the current or previous priority of
> the task with respect to its :term:`home scheduler` will be stored in this
> - variable.
> + object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -1246,9 +1246,9 @@ Gets the current priority of the task with respect to the scheduler.
> This parameter is the scheduler identifier.
>
> ``priority``
> - This parameter is the pointer to an :c:type:`rtems_task_priority` variable.
> + This parameter is the pointer to an :c:type:`rtems_task_priority` 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.
> + with respect to the specified scheduler will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -1340,9 +1340,9 @@ Gets and optionally sets the mode of the calling task.
> :c:macro:`RTEMS_CURRENT_MODE`, the mode of the calling task is not changed.
>
> ``previous_mode_set``
> - This parameter 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.
> + This parameter is the pointer to an :c:type:`rtems_mode` 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.
>
> .. rubric:: DESCRIPTION:
>
> @@ -1615,9 +1615,9 @@ Gets the home scheduler of the task.
> may be used to specify the calling task.
>
> ``scheduler_id``
> - This parameter is the pointer to an :c:type:`rtems_id` variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the :term:`home scheduler`
> - of the task will be stored in this variable.
> + of the task will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -1779,13 +1779,13 @@ Gets the processor affinity of the task.
> may be used to specify the calling task.
>
> ``cpusetsize``
> - This parameter is the size of the referenced processor set variable in
> + This parameter is the size of the processor set referenced by ``cpuset`` in
> bytes.
>
> ``cpuset``
> - This parameter is the pointer to a processor set variable. When the
> + This parameter is the pointer to a :c:type:`cpu_set_t` object. 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
> + 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.
>
> @@ -1807,8 +1807,8 @@ task specified by ``id``.
> There was no task associated with the identifier specified by ``id``.
>
> :c:macro:`RTEMS_INVALID_SIZE`
> - The provided processor set was too small for the processor affinity set of
> - the task.
> + The size specified by ``cpusetsize`` of the processor set was too small for
> + the processor affinity set of the task.
>
> :c:macro:`RTEMS_ILLEGAL_ON_REMOTE_OBJECT`
> The task resided on a remote node.
> @@ -1857,14 +1857,14 @@ Sets the processor affinity of the task.
> may be used to specify the calling task.
>
> ``cpusetsize``
> - This parameter is the size of the referenced processor set variable in
> + This parameter is the size of the processor set referenced by ``cpuset`` in
> bytes.
>
> ``cpuset``
> - This parameter 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.
> + This parameter is the pointer to a :c:type:`cpu_set_t` 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.
>
> .. rubric:: DESCRIPTION:
>
> diff --git a/c-user/timer/directives.rst b/c-user/timer/directives.rst
> index 2affe42..f020de4 100644
> --- a/c-user/timer/directives.rst
> +++ b/c-user/timer/directives.rst
> @@ -55,9 +55,9 @@ Creates a timer.
> This parameter is the object name of the timer.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the created timer will be
> - stored in this variable.
> + stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -137,9 +137,9 @@ Identifies a timer by the object name.
> This parameter is the object name to look up.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the object identifier of an object with the
> - specified name will be stored in this variable.
> + specified name will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -811,9 +811,9 @@ Gets information about the timer.
> This parameter is the timer identifier.
>
> ``the_info``
> - This parameter 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.
> + This parameter is the pointer to an :c:type:`rtems_timer_information`
> + object. When the directive call is successful, the information about the
> + timer will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> diff --git a/c-user/user-extensions/directives.rst b/c-user/user-extensions/directives.rst
> index 9aa1e9d..2dbac54 100644
> --- a/c-user/user-extensions/directives.rst
> +++ b/c-user/user-extensions/directives.rst
> @@ -64,9 +64,9 @@ Creates an extension set.
> set.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the identifier of the created extension set
> - will be stored in this variable.
> + will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> @@ -215,9 +215,9 @@ Identifies an extension set by the object name.
> This parameter is the object name to look up.
>
> ``id``
> - This parameter is the pointer to an object identifier variable. When the
> + This parameter is the pointer to an :c:type:`rtems_id` object. When the
> directive call is successful, the object identifier of an object with the
> - specified name will be stored in this variable.
> + specified name will be stored in this object.
>
> .. rubric:: DESCRIPTION:
>
> --
> 2.26.2
>
>
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel
More information about the devel
mailing list