doc: group logging features under subsystem/
Change-Id: Ia2d03e64071523086a693cd8627dcea223ff9b90 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
parent
7cb8a16c86
commit
ae6f8785cd
7 changed files with 46 additions and 49 deletions
|
@ -20,7 +20,6 @@ The Zephyr APIs are used the same way on all SoCs and boards.
|
|||
device.rst
|
||||
bluetooth.rst
|
||||
io_interfaces.rst
|
||||
event_logger.rst
|
||||
power_management_api
|
||||
file_system
|
||||
testing
|
||||
|
|
|
@ -1,30 +0,0 @@
|
|||
.. _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:
|
|
@ -13,6 +13,5 @@ This section describes other services provided by the kernel.
|
|||
atomic.rst
|
||||
float.rst
|
||||
ring_buffers.rst
|
||||
kernel_event_logger.rst
|
||||
c_library.rst
|
||||
cxx_support.rst
|
||||
|
|
8
doc/subsystems/logging/index.rst
Normal file
8
doc/subsystems/logging/index.rst
Normal file
|
@ -0,0 +1,8 @@
|
|||
Logging
|
||||
########
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
system_log
|
||||
kernel_event_logger
|
|
@ -234,8 +234,8 @@ Related configuration options:
|
|||
* :option:`CONFIG_KERNEL_EVENT_LOGGER_DYNAMIC`
|
||||
* :option:`CONFIG_KERNEL_EVENT_LOGGER_CUSTOM_TIMESTAMP`
|
||||
|
||||
APIs
|
||||
****
|
||||
Related Functions
|
||||
*******************
|
||||
|
||||
The following kernel event logger APIs are provided by
|
||||
:file:`kernel_event_logger.h`:
|
||||
|
@ -250,3 +250,27 @@ The following kernel event logger APIs are provided by
|
|||
* :cpp:func:`sys_k_event_logger_get_mask()`
|
||||
* :cpp:func:`sys_k_event_logger_set_mask()`
|
||||
* :cpp:func:`sys_k_event_logger_set_timer()`
|
||||
|
||||
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:
|
||||
|
||||
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:
|
|
@ -1,19 +1,7 @@
|
|||
.. _system_log:
|
||||
|
||||
Logging
|
||||
########
|
||||
|
||||
.. contents::
|
||||
:depth: 1
|
||||
:local:
|
||||
:backlinks: top
|
||||
|
||||
System Log
|
||||
************
|
||||
|
||||
.. doxygengroup:: system_log
|
||||
:project: Zephyr
|
||||
:content-only:
|
||||
System Logging
|
||||
##############
|
||||
|
||||
The system log API provides a common interface to process messages issued by
|
||||
developers. These messages are currently printed on the terminal but the API is
|
||||
|
@ -93,3 +81,12 @@ true:
|
|||
configuration is not set.
|
||||
- The module configuration is set to 2 or above.
|
||||
- The :option:`CONFIG_SYS_LOG_OVERRIDE_LEVEL` is set to 2 or above.
|
||||
|
||||
|
||||
APIs
|
||||
****
|
||||
|
||||
.. doxygengroup:: system_log
|
||||
:project: Zephyr
|
||||
:content-only:
|
||||
|
|
@ -15,4 +15,4 @@ to applications.
|
|||
sensor
|
||||
power_management.rst
|
||||
shell
|
||||
system_log
|
||||
logging/index
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue