Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

log: fix esp_log_level_set function name in docs

Browse source 
Fix documentation and comments to reflect the new esp_log_level_set API (and not deprecated esp_log_set_level)
This commit is contained in:
Lourens Naudé 2016-12-31 17:54:40 +00:00 committed by Ivan Grokhotkov
parent 5bd7e655b9
commit a8b75ed974
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
components/log/README.rst
View file

@ -4,11 +4,11 @@ Logging library
Overview
--------
Log library has two ways of managing log verbosity: compile time, set via menuconfig; and runtime, using ``esp_log_set_level`` function.
Log library has two ways of managing log verbosity: compile time, set via menuconfig; and runtime, using ``esp_log_level_set`` function.
At compile time, filtering is done using ``CONFIG_LOG_DEFAULT_LEVEL`` macro, set via menuconfig. All logging statments for levels higher than ``CONFIG_LOG_DEFAULT_LEVEL`` will be removed by the preprocessor.
At run time, all logs below ``CONFIG_LOG_DEFAULT_LEVEL`` are enabled by default. ``esp_log_set_level`` function may be used to set logging level per module. Modules are identified by their tags, which are human-readable ASCII zero-terminated strings.
At run time, all logs below ``CONFIG_LOG_DEFAULT_LEVEL`` are enabled by default. ``esp_log_level_set`` function may be used to set logging level per module. Modules are identified by their tags, which are human-readable ASCII zero-terminated strings.
How to use this library
-----------------------
@ -51,11 +51,11 @@ At component scope, define it in component makefile:
CFLAGS += -D LOG_LOCAL_LEVEL=ESP_LOG_DEBUG
To configure logging output per module at runtime, add calls to ``esp_log_set_level`` function:
To configure logging output per module at runtime, add calls to ``esp_log_level_set`` function:
.. code-block:: c
esp_log_set_level("*", ESP_LOG_ERROR); // set all components to ERROR level
esp_log_set_level("wifi", ESP_LOG_WARN); // enable WARN logs from WiFi stack
esp_log_set_level("dhcpc", ESP_LOG_INFO); // enable INFO logs from DHCP client
esp_log_level_set("*", ESP_LOG_ERROR); // set all components to ERROR level
esp_log_level_set("wifi", ESP_LOG_WARN); // enable WARN logs from WiFi stack
esp_log_level_set("dhcpc", ESP_LOG_INFO); // enable INFO logs from DHCP client

2
components/log/log.c
View file

@ -15,7 +15,7 @@
/*
* Log library — implementation notes.
*
* Log library stores all tags provided to esp_log_set_level as a linked
* Log library stores all tags provided to esp_log_level_set as a linked
* list. See uncached_tag_entry_t structure.
*
* To avoid looking up log level for given tag each time message is