[rtems-central commit] spec: Clarify rtems_partition_create()
Sebastian Huber
sebh at rtems.org
Wed Dec 2 07:01:12 UTC 2020
Module: rtems-central
Branch: master
Commit: dc190469dd1cb512bed1ed9994c4ae5e4a75a3a8
Changeset: http://git.rtems.org/rtems-central/commit/?id=dc190469dd1cb512bed1ed9994c4ae5e4a75a3a8
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Tue Dec 1 16:32:20 2020 +0100
spec: Clarify rtems_partition_create()
The rtems_partition_create() returns an object identifier and not just a
partition identifier.
---
spec/rtems/part/if/create.yml | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/spec/rtems/part/if/create.yml b/spec/rtems/part/if/create.yml
index dbe3cf6..ea8419a 100644
--- a/spec/rtems/part/if/create.yml
+++ b/spec/rtems/part/if/create.yml
@@ -21,9 +21,9 @@ description: |
This directive creates a partition of fixed size buffers from a physically
contiguous memory space which starts at ${.:/params[1]/name} and is
${.:/params[2]/name} bytes in size. Each allocated buffer is to be of
- ${.:/params[3]/name} in bytes. The assigned partition identifier is
- returned in ${.:/params[5]/name}. This partition identifier is used to
- access the partition with other partition related directives.
+ ${.:/params[3]/name} in bytes. The assigned object identifier is returned in
+ ${.:/params[5]/name}. This identifier is used to access the partition with
+ other partition related directives.
The **attribute set** specified in ${.:/params[4]/name} is built through
a *bitwise or* of the attribute constants described below. Attributes not
@@ -103,7 +103,7 @@ params:
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.
- dir: null
+ dir: out
name: id
return:
return: null
More information about the vc
mailing list