Apply new template for boolean feature defines.
Update #3900.
---
c-user/configuring_a_system.rst | 31 ++++++++++++++-----------------
1 file changed, 14 insertions(+), 17 deletions(-)
diff --git a/c-user/configuring_a_system.rst b/c-user/configuring_a_system.rst
index 87da412..11a7dd0 100644
--- a/c-user/configuring_a_system.rst
+++ b/c-user/configuring_a_system.rst
@@ -434,28 +434,25 @@ CONFIGURE_DIRTY_MEMORY
CONSTANT:
``CONFIGURE_DIRTY_MEMORY``
-DATA TYPE:
- Boolean feature macro.
-
-RANGE:
- Defined or undefined.
+OPTION TYPE:
+ This configuration option is a boolean feature define.
-DEFAULT VALUE:
- By default, the memory used by the RTEMS Workspace and the C Program Heap
- is uninitialized memory.
+DEFAULT CONFIGURATION:
+ If this configuration option is undefined, then the memory areas provided
+ by the BSP are not dirtied during system initialization.
DESCRIPTION:
- This macro indicates whether RTEMS should dirty the memory used by the
- RTEMS Workspace and the C Program Heap as part of its initialization. If
- defined, the memory areas are dirtied with a ``0xCF`` byte pattern.
- Otherwise, they are not.
+ In case this configuration option is defined, then the memory areas
+ provided by the BSP are dirtied during system initialization with a
+ ``0xCF`` byte pattern.
NOTES:
- Dirtying memory can add significantly to system boot time. It may assist
in
- finding code that incorrectly assumes the contents of free memory areas is
- cleared to zero during system initialization. In case
- :ref:`CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY` is also defined, then the
- memory is first dirtied and then zeroed.
+ The memory areas provided by the BSP are used for the RTEMS Workspace and
+ the C Program Heap. Dirtying memory can add significantly to system
+ initialization time. It may assist in finding code that incorrectly
+ assumes the contents of free memory areas is cleared to zero during system
+ initialization. In case :ref:`CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY` is
+ also defined, then the memory is first dirtied and then zeroed.
.. index:: CONFIGURE_EXTRA_TASK_STACKS
.. index:: memory for task tasks
--
2.16.4
_______________________________________________
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel
