diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-18 16:50:00 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-24 07:48:21 +0100 |
| commit | dfe0ec05b9c06e7dc915788e24c74582f51791f9 (patch) | |
| tree | 627bc13ac8c3b148beeb9270c7681f465224e827 /c-user/config/event-record.rst | |
| parent | posix-compliance: Add some missing methods (diff) | |
| download | rtems-docs-dfe0ec05b9c06e7dc915788e24c74582f51791f9.tar.bz2 | |
c-user: Use new template for feature config opts
Try to bring all descriptions up to date. Add cross-references to
several options.
Close #3900.
Diffstat (limited to 'c-user/config/event-record.rst')
| -rw-r--r-- | c-user/config/event-record.rst | 28 |
1 files changed, 15 insertions, 13 deletions
diff --git a/c-user/config/event-record.rst b/c-user/config/event-record.rst index 01e9af2..8ca9534 100644 --- a/c-user/config/event-record.rst +++ b/c-user/config/event-record.rst @@ -1,6 +1,6 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +.. Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de) Event Recording Configuration ============================= @@ -17,23 +17,25 @@ CONFIGURE_RECORD_EXTENSIONS_ENABLED CONSTANT: ``CONFIGURE_RECORD_EXTENSIONS_ENABLED`` -DATA TYPE: - Boolean feature macro. - -RANGE: - Defined or undefined. +OPTION TYPE: + This configuration option is a boolean feature define. -DEFAULT VALUE: - This is not defined by default. +DEFAULT CONFIGURATION: + If this configuration option is undefined, then the described feature is not + enabled. DESCRIPTION: - If defined and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS - <CONFIGURE_RECORD_PER_PROCESSOR_ITEMS>` is also defined properly, then the - record extensions are enabled. + In case + + * this configuration option is defined + + * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined, + + then the event record extensions are enabled. NOTES: - The record extensions capture thread create, start, restart, delete, - switch, begin, exitted and terminate events. + The record extensions capture thread create, start, restart, delete, switch, + begin, exitted and terminate events. .. index:: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS |