RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

rtems: Clarify rtems_partition_create()

Browse Source 
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:35:05 +01:00
parent 5555c0cb98
commit 8756d5ce06
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
cpukit/include/rtems/rtems/part.h
View File

@@ -97,9 +97,9 @@ extern "C" {
* 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.
* in bytes. 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
@@ -161,9 +161,9 @@ extern "C" {
*
* @param attribute_set is the attribute set of the partition.
*
* @param id is the pointer to an object identifier variable. The identifier
* of the created partition object will be stored in this variable, in case
* of a successful operation.
* @param[out] id is the pointer to an object identifier variable. The
* identifier of the created partition object will be stored in this
* variable, in case of a successful operation.
*
* @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
*