[PATCH] c-user: Clarify rtems_partition_create()

Sebastian Huber sebastian.huber at embedded-brains.de
Tue Dec 1 15:34:26 UTC 2020


The rtems_partition_create() returns an object identifier and not just a
partition identifier.

Update #3993.
---
 c-user/partition/directives.rst | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/c-user/partition/directives.rst b/c-user/partition/directives.rst
index 1a76ad0..9579877 100644
--- a/c-user/partition/directives.rst
+++ b/c-user/partition/directives.rst
@@ -81,9 +81,8 @@ Creates a partition.
 This directive creates a partition of fixed size buffers from a physically
 contiguous memory space which starts at ``starting_address`` and is ``length``
 bytes in size.  Each allocated buffer is to be of ``buffer_size`` in bytes.
-The assigned partition identifier is returned in ``id``.  This partition
-identifier is used to access the partition with other partition related
-directives.
+The assigned object identifier is returned in ``id``.  This identifier is used
+to access the partition with other partition related directives.
 
 The **attribute set** specified in ``attribute_set`` is built through a
 *bitwise or* of the attribute constants described below.  Attributes not
-- 
2.26.2



More information about the devel mailing list