From 8756d5ce06d8d5f8f9f205601cd051211681d470 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Tue, 1 Dec 2020 16:35:05 +0100 Subject: rtems: Clarify rtems_partition_create() The rtems_partition_create() returns an object identifier and not just a partition identifier. Update #3993. --- cpukit/include/rtems/rtems/part.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'cpukit/include/rtems/rtems/part.h') diff --git a/cpukit/include/rtems/rtems/part.h b/cpukit/include/rtems/rtems/part.h index 16f7effd6c..db861a8df0 100644 --- a/cpukit/include/rtems/rtems/part.h +++ b/cpukit/include/rtems/rtems/part.h @@ -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. * -- cgit v1.2.3