michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: logging: Add note about v1 deprecation

Browse source 
Added note about v1 deprecation.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
This commit is contained in:
Krzysztof Chruscinski 2022-01-12 11:28:01 +01:00 • committed by Anas Nashif
commit dd4035c624
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/reference/logging/index.rst
View file

@ -50,6 +50,12 @@ Logging v2 introduces following changes:
- No change in logging API - No change in logging API
- Logging backend API exteded with function for processing v2 messages. - Logging backend API exteded with function for processing v2 messages.
.. note::
Logging v1 is deprecated! Version 2 supports same set of features with listed
above extensions. However, logging backend API is different. All backends in
the tree support version 2 API. Any custom backend must be adapted to version 2.
Version 1 support will be removed after 3.1 release.
Logging API is highly configurable at compile time as well as at run time. Using Logging API is highly configurable at compile time as well as at run time. Using
Kconfig options (see :ref:`logging_kconfig`) logs can be gradually removed from Kconfig options (see :ref:`logging_kconfig`) logs can be gradually removed from
compilation to reduce image size and execution time when logs are not needed. compilation to reduce image size and execution time when logs are not needed.