summaryrefslogtreecommitdiffstats
path: root/c-user/region/directives.rst
diff options
context:
space:
mode:
Diffstat (limited to 'c-user/region/directives.rst')
-rw-r--r--c-user/region/directives.rst38
1 files changed, 19 insertions, 19 deletions
diff --git a/c-user/region/directives.rst b/c-user/region/directives.rst
index 86bb537..557b89e 100644
--- a/c-user/region/directives.rst
+++ b/c-user/region/directives.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2021 embedded brains GmbH & Co. KG
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -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
- directive call is successful, the identifier of the created region will be
- stored in this variable.
+ This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
+ the directive call is successful, the identifier of the created region will
+ be 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
- directive call is successful, the object identifier of an object with the
- specified name will be stored in this variable.
+ This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
+ the directive call is successful, the object identifier of an object with
+ the 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 :c:type:`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 :c:type:`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: