c-user: Clarify rtems_partition_create()

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

Update #3993.
This commit is contained in:
Sebastian Huber 2020-12-01 16:33:33 +01:00
parent 284e8d0421
commit 29e6caa311

View File

@ -81,9 +81,8 @@ Creates a partition.
This directive creates a partition of fixed size buffers from a physically This directive creates a partition of fixed size buffers from a physically
contiguous memory space which starts at ``starting_address`` and is ``length`` 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. bytes in size. Each allocated buffer is to be of ``buffer_size`` in bytes.
The assigned partition identifier is returned in ``id``. This partition The assigned object identifier is returned in ``id``. This identifier is used
identifier is used to access the partition with other partition related to access the partition with other partition related directives.
directives.
The **attribute set** specified in ``attribute_set`` is built through a The **attribute set** specified in ``attribute_set`` is built through a
*bitwise or* of the attribute constants described below. Attributes not *bitwise or* of the attribute constants described below. Attributes not