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

rtems: Clarify partition manager documentation

Browse Source 
Unify the wording across similar directives of other managers.

Update #3993.
This commit is contained in:
Sebastian Huber
2021-02-10 06:44:12 +01:00
parent f9dc44afc7
commit bf3b9f4536
1 changed files with 15 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -112,9 +112,9 @@ extern "C" {
*
* @param attribute_set is the attribute set of the partition.
*
* @param[out] id is the pointer to an object identifier variable. The
* identifier of the created partition will be stored in this variable, in
* case of a successful operation.
* @param[out] id is the pointer to an object identifier variable. When the
* directive call is successful, the identifier of the created partition will
* be stored in this variable.
*
* This directive creates a partition of fixed size buffers from a physically
* contiguous memory space which starts at ``starting_address`` and is
@@ -216,6 +216,9 @@ extern "C" {
* * The directive may obtain and release the object allocator mutex. This may
* cause the calling task to be preempted.
*
* * When the directive operates on a global object, the directive sends a
* message to remote nodes. This may preempt the calling task.
*
* * The number of partitions available to the application is configured
* through the #CONFIGURE_MAXIMUM_PARTITIONS application configuration
* option.
@@ -249,9 +252,9 @@ rtems_status_code rtems_partition_create(
*
* @param node is the node or node set to search for a matching object.
*
* @param[out] id is the pointer to an object identifier variable. The object
* identifier of an object with the specified name will be stored in this
* variable, in case of a successful operation.
* @param[out] id is the pointer to an object identifier variable. When the
* directive call is successful, the object identifier of an object with the
* specified name will be stored in this variable.
*
* This directive obtains a partition identifier associated with the partition
* name specified in ``name``.
@@ -364,6 +367,9 @@ rtems_status_code rtems_partition_ident(
* * The directive may obtain and release the object allocator mutex. This may
* cause the calling task to be preempted.
*
* * When the directive operates on a global object, the directive sends a
* message to remote nodes. This may preempt the calling task.
*
* * The calling task does not have to be the task that created the object.
* Any local task that knows the object identifier can delete the object.
*
@@ -382,9 +388,9 @@ rtems_status_code rtems_partition_delete( rtems_id id );
*
* @param id is the partition identifier.
*
* @param[out] buffer is the pointer to a buffer pointer variable. The pointer
* to the allocated buffer will be stored in this variable, in case of a
* successful operation.
* @param[out] buffer is the pointer to a buffer pointer variable. When the
* directive call is successful, the pointer to the allocated buffer will be
* stored in this variable.
*
* This directive allows a buffer to be obtained from the partition specified
* by ``id``. The address of the allocated buffer is returned through the