[PATCH] c-user: Update partition create documentation

Sebastian Huber sebastian.huber at embedded-brains.de
Thu Aug 2 13:26:29 UTC 2018


Close #3482.
---
 c-user/partition_manager.rst | 24 +++++++++++++-----------
 1 file changed, 13 insertions(+), 11 deletions(-)

diff --git a/c-user/partition_manager.rst b/c-user/partition_manager.rst
index 68761da..61a6c7a 100644
--- a/c-user/partition_manager.rst
+++ b/c-user/partition_manager.rst
@@ -162,21 +162,23 @@ DIRECTIVE STATUS CODES:
      * - ``RTEMS_SUCCESSFUL``
        - partition created successfully
      * - ``RTEMS_INVALID_NAME``
-       - invalid partition name
+       - invalid partition ``name``
      * - ``RTEMS_TOO_MANY``
        - too many partitions created
      * - ``RTEMS_INVALID_ADDRESS``
-       - address not on four byte boundary
+       - ``starting_address`` is not on a pointer size boundary
      * - ``RTEMS_INVALID_ADDRESS``
        - ``starting_address`` is NULL
      * - ``RTEMS_INVALID_ADDRESS``
        - ``id`` is NULL
      * - ``RTEMS_INVALID_SIZE``
-       - length or buffer size is 0
+       - ``length`` or ``buffer_size`` is 0
      * - ``RTEMS_INVALID_SIZE``
-       - length is less than the buffer size
+       - ``length`` is less than the ``buffer_size``
      * - ``RTEMS_INVALID_SIZE``
-       - buffer size not a multiple of 4
+       - ``buffer_size`` is not an integral multiple of the pointer size
+     * - ``RTEMS_INVALID_SIZE``
+       - ``buffer_size`` is less than two times the pointer size
      * - ``RTEMS_MP_NOT_CONFIGURED``
        - multiprocessing not configured
      * - ``RTEMS_TOO_MANY``
@@ -194,13 +196,13 @@ DESCRIPTION:
 NOTES:
     This directive will not cause the calling task to be preempted.
 
-    The ``starting_address`` must be properly aligned for the target
-    architecture.
+    The ``starting_address`` must be properly aligned to naturally store target
+    architecture pointers.
 
-    The ``buffer_size`` parameter must be a multiple of the CPU alignment
-    factor.  Additionally, ``buffer_size`` must be large enough to hold two
-    pointers on the target architecture.  This is required for RTEMS to manage
-    the buffers when they are free.
+    The ``buffer_size`` parameter must be an integral multiple of the pointer
+    size on the target architecture.  Additionally, ``buffer_size`` must be
+    large enough to hold two pointers on the target architecture.  This is
+    required for RTEMS to manage the buffers when they are free.
 
     Memory from the partition is not used by RTEMS to store the Partition
     Control Block.
-- 
2.13.7



More information about the devel mailing list