rtems: Clarify rtems_partition_delete()

Move the PTCB sentence to the notes to be in line with
rtems_partition_create().

Update #3993.
This commit is contained in:
Sebastian Huber
2020-12-02 08:16:03 +01:00
parent 8756d5ce06
commit 5a285e3844
+3 -2
View File
@@ -271,12 +271,13 @@ rtems_status_code rtems_partition_ident(
* @brief Deletes the partition.
*
* This directive deletes the partition specified by the ``id`` parameter. The
* partition cannot be deleted if any of its buffers are still allocated. The
* PTCB for the deleted partition is reclaimed by RTEMS.
* partition cannot be deleted if any of its buffers are still allocated.
*
* This directive may cause the calling task to be preempted due to an obtain
* and release of the object allocator mutex.
*
* The PTCB for the deleted partition is reclaimed by RTEMS.
*
* The calling task does not have to be the task that created the partition.
* Any local task that knows the partition identifier can delete the partition.
*