[PATCH] c-user: Regenerate for IDLE task allocator option

Sebastian Huber sebastian.huber at embedded-brains.de
Tue Oct 19 14:43:38 UTC 2021


Update #4524.
---
 c-user/config/task-stack-alloc.rst | 71 ++++++++++++++++--------------
 1 file changed, 37 insertions(+), 34 deletions(-)

diff --git a/c-user/config/task-stack-alloc.rst b/c-user/config/task-stack-alloc.rst
index 36b780b..0e2ec10 100644
--- a/c-user/config/task-stack-alloc.rst
+++ b/c-user/config/task-stack-alloc.rst
@@ -1,7 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
 .. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
-.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+.. Copyright (C) 1988, 2021 On-Line Applications Research Corporation (OAR)
 
 .. This file is part of the RTEMS quality process and was automatically
 .. generated.  If you find something that needs to be fixed or
@@ -93,6 +93,42 @@ NOTES:
     This configuration option may be used if a custom task stack allocator is
     configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`.
 
+.. Generated from spec:/acfg/if/task-stack-allocator-for-idle
+
+.. index:: CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE
+.. index:: task stack allocator for IDLE tasks
+
+.. _CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE:
+
+CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE
+---------------------------------------
+
+CONSTANT:
+    ``CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE``
+
+OPTION TYPE:
+    This configuration option is an initializer define.
+
+DEFAULT VALUE:
+    The default value is ``_Stack_Allocator_allocate_for_idle_default``, which
+    indicates that IDLE task stacks will be allocated from an area statically
+    allocated by ``<rtems/confdefs.h>``.
+
+VALUE CONSTRAINTS:
+    The value of this configuration option shall be defined to a valid function
+    pointer of the type ``void *( *allocate )( uint32_t, size_t )``.
+
+DESCRIPTION:
+    The value of this configuration option is the address for the stack allocator
+    allocate handler used to allocate the task stack of each
+    :term:`IDLE task`.
+
+NOTES:
+    This configuration option is independent of the other thread stack allocator
+    configuration options.  It is assumed that any memory allocated for the stack
+    of an :term:`IDLE task` will not be from the RTEMS Workspace or the
+    memory statically allocated by default.
+
 .. Generated from spec:/acfg/if/task-stack-allocator-init
 
 .. index:: CONFIGURE_TASK_STACK_ALLOCATOR_INIT
@@ -214,36 +250,3 @@ DESCRIPTION:
 NOTES:
     This configuration option may be used if a custom task stack allocator is
     configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`.
-
-.. index:: _CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE
-.. index:: IDLE task stack allocator
-
-.. _CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE:
-
-CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE
----------------------------------------
-
-CONSTANT:
-    ``CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE``
-
-OPTION TYPE:
-    This configuration option is an initializer define.
-
-DEFAULT VALUE:
-    The default value is ``_Stack_Allocator_allocate_for_idle``, which
-    indicates that IDLE task stacks will be allocated from an area statically
-    reserved by `<rtems/confdefs.h>``.
-
-VALUE CONSTRAINTS:
-    The value of this configuration option shall be defined to a valid
-    function pointer of the type ``void *( *allocate )( uint32_t, size_t )``.
-
-DESCRIPTION:
-    The value of this configuration option is the address for the the
-    IDLE stack allocator allocate handler.
-
-NOTES:
-    This configuration option is independent of the other thread stack allocator
-    configuration options. It is assumed that any memory allocated for IDLE
-    task stacks will not be from the RTEMS Workspace or the memory statically
-    reserved by default.
-- 
2.31.1



More information about the devel mailing list