Changeset e57733a in rtems-docs


Ignore:
Timestamp:
Feb 10, 2020, 9:28:49 AM (5 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
5, master
Children:
76b3aea
Parents:
b6c61e3
git-author:
Sebastian Huber <sebastian.huber@…> (02/10/20 09:28:49)
git-committer:
Sebastian Huber <sebastian.huber@…> (02/10/20 09:29:21)
Message:

c-user: Document CONFIGURE_DIRTY_MEMORY

Close #3843.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • c-user/configuring_a_system.rst

    rb6c61e3 re57733a  
    426426``<rtems/confdefs.h>``.
    427427
     428.. index:: CONFIGURE_DIRTY_MEMORY
     429
     430.. _CONFIGURE_DIRTY_MEMORY:
     431
     432CONFIGURE_DIRTY_MEMORY
     433----------------------
     434
     435CONSTANT:
     436    ``CONFIGURE_DIRTY_MEMORY``
     437
     438DATA TYPE:
     439    Boolean feature macro.
     440
     441RANGE:
     442    Defined or undefined.
     443
     444DEFAULT VALUE:
     445    By default, the memory used by the RTEMS Workspace and the C Program Heap
     446    is uninitialized memory.
     447
     448DESCRIPTION:
     449    This macro indicates whether RTEMS should dirty the memory used by the
     450    RTEMS Workspace and the C Program Heap as part of its initialization.  If
     451    defined, the memory areas are dirtied with a ``0xCF`` byte pattern.
     452    Otherwise, they are not.
     453
     454NOTES:
     455    Dirtying memory can add significantly to system boot time.  It may assist
     456    in finding code that assumes memory starts set to zero.  In case
     457    :ref:`CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY` is also defined, then the
     458    memory is first dirtied and then zeroed.
     459
    428460.. index:: CONFIGURE_EXTRA_TASK_STACKS
    429461.. index:: memory for task tasks
     
    10071039NOTES:
    10081040    Zeroing memory can add significantly to system boot time. It is not
    1009     necessary for RTEMS but is often assumed by support libraries.
     1041    necessary for RTEMS but is often assumed by support libraries.  In case
     1042    :ref:`CONFIGURE_DIRTY_MEMORY` is also defined, then the memory is first
     1043    dirtied and then zeroed.
    10101044
    10111045Classic API Configuration
Note: See TracChangeset for help on using the changeset viewer.