Skip to content

Commit

Permalink
doc: Revise kernel event logger documentation
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
ajstephens authored and Anas Nashif committed Nov 18, 2016
1 parent 72efec3 commit d7b355b
Show file tree
Hide file tree
Showing 5 changed files with 270 additions and 297 deletions.
20 changes: 17 additions & 3 deletions doc/api/event_logger.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _event_logger:

Event Logger APIs
#################
Event Logging APIs
##################

.. contents::
:depth: 1
Expand All @@ -11,6 +11,20 @@ Event Logger APIs
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:
: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:
11 changes: 0 additions & 11 deletions doc/api/kernel_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -237,14 +237,3 @@ of variable-size data items.
.. doxygengroup:: ring_buffer_apis
:project: Zephyr
:content-only:

Kernel Event Logger
*******************

The kernel event logger is a standardized mechanism to record events within the
kernel while providing a single interface for the user to collect the data.
(See :ref:`event_logger_v2`.)

.. doxygengroup:: event_logger
:project: Zephyr
:content-only:
282 changes: 0 additions & 282 deletions doc/kernel_v2/other/event_logger.rst

This file was deleted.

Loading

0 comments on commit d7b355b

Please sign in to comment.