Changeset 62d58f2 in rtems-docs


Ignore:
Timestamp:
Mar 24, 2020, 6:47:18 AM (2 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
03e61e9
Parents:
dfe0ec0
git-author:
Sebastian Huber <sebastian.huber@…> (03/24/20 06:47:18)
git-committer:
Sebastian Huber <sebastian.huber@…> (03/24/20 06:48:40)
Message:

c-user: Document new event record config options

Update #3904.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • c-user/config/event-record.rst

    rdfe0ec0 r62d58f2  
    11.. SPDX-License-Identifier: CC-BY-SA-4.0
    22
    3 .. Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de)
     3.. Copyright (C) 2019, 2020 embedded brains GmbH (http://www.embedded-brains.de)
    44
    55Event Recording Configuration
     
    3838    begin, exitted and terminate events.
    3939
     40.. index:: CONFIGURE_RECORD_FATAL_DUMP_BASE64
     41
     42.. _CONFIGURE_RECORD_FATAL_DUMP_BASE64:
     43
     44CONFIGURE_RECORD_FATAL_DUMP_BASE64
     45----------------------------------
     46
     47CONSTANT:
     48    ``CONFIGURE_RECORD_FATAL_DUMP_BASE64``
     49
     50OPTION TYPE:
     51    This configuration option is a boolean feature define.
     52
     53DEFAULT CONFIGURATION:
     54    If this configuration option is undefined, then the described feature is not
     55    enabled.
     56
     57DESCRIPTION:
     58    In case
     59
     60    * this configuration option is defined
     61
     62    * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
     63
     64    * and :ref:`CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB` is undefined,
     65
     66    then the event records are dumped in Base64 encoding in a fatal error
     67    extension (see :ref:`Terminate`).
     68
     69NOTES:
     70    This extension can be used to produce crash dumps.
     71
     72.. index:: CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB
     73
     74.. _CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB:
     75
     76CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB
     77---------------------------------------
     78
     79CONSTANT:
     80    ``CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB``
     81
     82OPTION TYPE:
     83    This configuration option is a boolean feature define.
     84
     85DEFAULT CONFIGURATION:
     86    If this configuration option is undefined, then the described feature is not
     87    enabled.
     88
     89DESCRIPTION:
     90    In case
     91
     92    * this configuration option is defined
     93
     94    * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
     95
     96    then the event records are compressed by zlib and dumped in Base64 encoding
     97    in a fatal error extension (see :ref:`Terminate`).
     98
     99NOTES:
     100    The zlib compression needs about 512KiB of RAM.  This extension can be used
     101    to produce crash dumps.
     102
    40103.. index:: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
    41104
Note: See TracChangeset for help on using the changeset viewer.