summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-02-09 10:35:37 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-02-10 16:42:52 +0100
commit45d38114801d091d1af017dc91ea57f58f538da5 (patch)
tree39d4c4c131174791c69e7fdffe52c93ccc224bc9
parentc-user: Clarify event manager documentation (diff)
downloadrtems-docs-45d38114801d091d1af017dc91ea57f58f538da5.tar.bz2
c-user: Clarify partition manager documentation
-rw-r--r--c-user/partition/directives.rst24
1 files changed, 15 insertions, 9 deletions
diff --git a/c-user/partition/directives.rst b/c-user/partition/directives.rst
index 0d35136..98c0eb1 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. The
- identifier of the created partition will be stored in this variable, in
- case of a successful operation.
+ This parameter 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.
.. rubric:: DESCRIPTION:
@@ -191,6 +191,9 @@ The following constraints apply to this directive:
* The directive may obtain and release the object allocator mutex. This may
cause the calling task to be preempted.
+* When the directive operates on a global object, the directive sends a message
+ to remote nodes. This may preempt the calling task.
+
* The number of partitions available to the application is configured through
the :ref:`CONFIGURE_MAXIMUM_PARTITIONS` application configuration option.
@@ -238,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. The object
- identifier of an object with the specified name will be stored in this
- variable, in case of a successful operation.
+ 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.
.. rubric:: DESCRIPTION:
@@ -374,6 +377,9 @@ The following constraints apply to this directive:
* The directive may obtain and release the object allocator mutex. This may
cause the calling task to be preempted.
+* When the directive operates on a global object, the directive sends a message
+ to remote nodes. This may preempt the calling task.
+
* The calling task does not have to be the task that created the object. Any
local task that knows the object identifier can delete the object.
@@ -409,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. The pointer to
- the allocated buffer will be stored in this variable, in case of a
- successful operation.
+ This parameter 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.
.. rubric:: DESCRIPTION: