summaryrefslogtreecommitdiffstats
path: root/c-user/config/event-record.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-11-16 08:17:31 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-11-17 09:08:53 +0100
commit1c8ce332e273bb9f10cdb18e32e977cb9301fbad (patch)
tree8622528cf6fb748d6196ba5b9a46bf8c10b941bc /c-user/config/event-record.rst
parentc-user: CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS (diff)
downloadrtems-docs-1c8ce332e273bb9f10cdb18e32e977cb9301fbad.tar.bz2
c-user: Use rubric for configuration options
Clear the page for each configuration options similar to the directives. Use a rubric instead of a definition list for the application configuration options similar to the directive documentation pages. For direcives and application configuration options use the same rubric order. Generalize value constraints to constraints. This patch does not change hand written content.
Diffstat (limited to 'c-user/config/event-record.rst')
-rw-r--r--c-user/config/event-record.rst176
1 files changed, 106 insertions, 70 deletions
diff --git a/c-user/config/event-record.rst b/c-user/config/event-record.rst
index fa1d011..31a4fa9 100644
--- a/c-user/config/event-record.rst
+++ b/c-user/config/event-record.rst
@@ -26,6 +26,10 @@ This section describes configuration options related to the event recording.
.. Generated from spec:/acfg/if/record-extensions-enabled
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_RECORD_EXTENSIONS_ENABLED
.. _CONFIGURE_RECORD_EXTENSIONS_ENABLED:
@@ -33,31 +37,40 @@ This section describes configuration options related to the event recording.
CONFIGURE_RECORD_EXTENSIONS_ENABLED
-----------------------------------
-CONSTANT:
- ``CONFIGURE_RECORD_EXTENSIONS_ENABLED``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_RECORD_EXTENSIONS_ENABLED``
+
+.. rubric:: OPTION TYPE:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+This configuration option is a boolean feature define.
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+.. rubric:: DEFAULT CONFIGURATION:
-DESCRIPTION:
- In case
+If this configuration option is undefined, then the described feature is not
+enabled.
- * this configuration option is defined
+.. rubric:: DESCRIPTION:
- * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
+In case
- then the event record extensions are enabled.
+* this configuration option is defined
-NOTES:
- The record extensions capture thread create, start, restart, delete, switch,
- begin, exitted and terminate events.
+* and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
+
+then the event record extensions are enabled.
+
+.. rubric:: NOTES:
+
+The record extensions capture thread create, start, restart, delete, switch,
+begin, exitted and terminate events.
.. Generated from spec:/acfg/if/record-fatal-dump-base64
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_RECORD_FATAL_DUMP_BASE64
.. _CONFIGURE_RECORD_FATAL_DUMP_BASE64:
@@ -65,33 +78,42 @@ NOTES:
CONFIGURE_RECORD_FATAL_DUMP_BASE64
----------------------------------
-CONSTANT:
- ``CONFIGURE_RECORD_FATAL_DUMP_BASE64``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_RECORD_FATAL_DUMP_BASE64``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DEFAULT CONFIGURATION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+If this configuration option is undefined, then the described feature is not
+enabled.
-DESCRIPTION:
- In case
+.. rubric:: DESCRIPTION:
- * this configuration option is defined
+In case
- * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
+* this configuration option is defined
- * and :ref:`CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB` is undefined,
+* and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
- then the event records are dumped in Base64 encoding in a fatal error
- extension (see :ref:`Terminate`).
+* and :ref:`CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB` is undefined,
-NOTES:
- This extension can be used to produce crash dumps.
+then the event records are dumped in Base64 encoding in a fatal error
+extension (see :ref:`Terminate`).
+
+.. rubric:: NOTES:
+
+This extension can be used to produce crash dumps.
.. Generated from spec:/acfg/if/record-fatal-dump-base64-zlib
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB
.. _CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB:
@@ -99,32 +121,41 @@ NOTES:
CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB
---------------------------------------
-CONSTANT:
- ``CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DEFAULT CONFIGURATION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+If this configuration option is undefined, then the described feature is not
+enabled.
-DESCRIPTION:
- In case
+.. rubric:: DESCRIPTION:
- * this configuration option is defined
+In case
- * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
+* this configuration option is defined
- then the event records are compressed by zlib and dumped in Base64 encoding
- in a fatal error extension (see :ref:`Terminate`).
+* and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
-NOTES:
- The zlib compression needs about 512KiB of RAM. This extension can be used
- to produce crash dumps.
+then the event records are compressed by zlib and dumped in Base64 encoding
+in a fatal error extension (see :ref:`Terminate`).
+
+.. rubric:: NOTES:
+
+The zlib compression needs about 512KiB of RAM. This extension can be used
+to produce crash dumps.
.. Generated from spec:/acfg/if/record-per-processor-items
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
.. _CONFIGURE_RECORD_PER_PROCESSOR_ITEMS:
@@ -132,35 +163,40 @@ NOTES:
CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
------------------------------------
-CONSTANT:
- ``CONFIGURE_RECORD_PER_PROCESSOR_ITEMS``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_RECORD_PER_PROCESSOR_ITEMS``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is an integer define.
+
+.. rubric:: DEFAULT VALUE:
+
+The default value is 0.
+
+.. rubric:: DESCRIPTION:
-OPTION TYPE:
- This configuration option is an integer define.
+The value of this configuration option defines the event record item count
+per processor.
-DEFAULT VALUE:
- The default value is 0.
+.. rubric:: NOTES:
-VALUE CONSTRAINTS:
- The value of this configuration option shall satisfy all of the following
- constraints:
+The event record buffers are statically allocated for each configured
+processor (:ref:`CONFIGURE_MAXIMUM_PROCESSORS`). If the value of this
+configuration option is zero, then nothing is allocated.
- * It shall be greater than or equal to 16.
+.. rubric:: CONSTRAINTS:
- * It shall be less than or equal to `SIZE_MAX
- <https://en.cppreference.com/w/c/types/limits>`_.
+The following constraints apply to this configuration option:
- * It shall be a power of two.
+* The value of the configuration option shall be greater than or equal to 16.
- * It shall be less than or equal to a BSP-specific and application-specific
- value which depends on the size of the memory available to the
- application.
+* The value of the configuration option shall be less than or equal to
+ `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
-DESCRIPTION:
- The value of this configuration option defines the event record item count
- per processor.
+* The value of the configuration option shall be a power of two.
-NOTES:
- The event record buffers are statically allocated for each configured
- processor (:ref:`CONFIGURE_MAXIMUM_PROCESSORS`). If the value of this
- configuration option is zero, then nothing is allocated.
+* The value of the configuration option shall be less than or equal to a
+ BSP-specific and application-specific value which depends on the size of the
+ memory available to the application.