summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-01 16:32:20 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-01 16:35:54 +0100
commitdc190469dd1cb512bed1ed9994c4ae5e4a75a3a8 (patch)
treedca6fde2f0ac3926a8780889eec9d6704ab51b1f
parentinterface/interfacedoc: Format parameter names (diff)
downloadrtems-central-dc190469dd1cb512bed1ed9994c4ae5e4a75a3a8.tar.bz2
spec: Clarify rtems_partition_create()
The rtems_partition_create() returns an object identifier and not just a partition identifier.
-rw-r--r--spec/rtems/part/if/create.yml8
1 files changed, 4 insertions, 4 deletions
diff --git a/spec/rtems/part/if/create.yml b/spec/rtems/part/if/create.yml
index dbe3cf64..ea8419ab 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