d7b355b865
Makes the purpose and capabilities of the kernel event logger clearer, and leaves much of the low-level detail relating to use of the configuration options and APIs to the configuration option guide and API guide, respectively. Also corrects some bugs in the example code for retrieving event information. Also updates the API guide to make a clear distinction between the general purpose event logger framework and the kernel event logger (which is a specific instance of this framework). Change-Id: I924f65092b2b0e5050af13376b5da85a6cdc1a65 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
31 lines
629 B
ReStructuredText
31 lines
629 B
ReStructuredText
.. _event_logger:
|
|
|
|
Event Logging APIs
|
|
##################
|
|
|
|
.. contents::
|
|
:depth: 1
|
|
:local:
|
|
:backlinks: top
|
|
|
|
Event Logger
|
|
************
|
|
|
|
An event logger is an object that can record the occurrence of significant
|
|
events, which can be subsequently extracted and reviewed.
|
|
|
|
.. doxygengroup:: event_logger
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
Kernel Event Logger
|
|
*******************
|
|
|
|
The kernel event logger records the occurrence of significant kernel events,
|
|
which can be subsequently extracted and reviewed.
|
|
(See :ref:`kernel_event_logger_v2`.)
|
|
|
|
.. doxygengroup:: kernel_event_logger
|
|
:project: Zephyr
|
|
:content-only:
|