doc: logging: document `LOG_WRN_ONCE`

Document the existence of `LOG_WRN_ONCE`.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
This commit is contained in:
Jordan Yates 2024-03-15 20:58:08 +10:00 committed by Fabio Baltieri
parent 61ee9f4fbf
commit ca36feeca8
1 changed files with 5 additions and 1 deletions

View File

@ -46,7 +46,7 @@ There are four severity levels available in the system: error, warning, info
and debug. For each severity level the logging API (:zephyr_file:`include/zephyr/logging/log.h`)
has set of dedicated macros. Logger API also has macros for logging data.
For each level following set of macros are available:
For each level the following set of macros are available:
- ``LOG_X`` for standard printf-like messages, e.g. :c:macro:`LOG_ERR`.
- ``LOG_HEXDUMP_X`` for dumping data, e.g. :c:macro:`LOG_HEXDUMP_WRN`.
@ -55,6 +55,10 @@ For each level following set of macros are available:
- ``LOG_INST_HEXDUMP_X`` for dumping data associated with the particular
instance, e.g. :c:macro:`LOG_HEXDUMP_INST_DBG`
The warning level also exposes the following additional macro:
- :c:macro:`LOG_WRN_ONCE` for warnings where only the first occurrence is of interest.
There are two configuration categories: configurations per module and global
configuration. When logging is enabled globally, it works for modules. However,
modules can disable logging locally. Every module can specify its own logging