Mirrors/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-08-18 06:35:35 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update CN translation

Browse Source
This commit is contained in:
Zhang Shuxian
2025-11-21 14:31:15 +08:00
committed by Peter Dragun
parent 00365a4b07
commit 6e321e3dae
2 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en/api-reference/system/log.rst
View File

@@ -196,9 +196,7 @@ The logging system supports the following formatting options, applicable for bot
.. note::
Please note that IDF Monitor expects the format described above of log messages to automatically color logs. The minimal required format is log level name followed by timestamp. A newline marks the end of the log message. E.g., ``I (56): Log message\n``
If this format is not followed, for example by disabling the timestamp, then automatic log coloring will not work. In such situations, it is recommended to enable :ref:`CONFIG_LOG_COLORS` in the menuconfig.
Another related restriction is for multi-line logs where only the first line will be colored correctly.
Please note that IDF Monitor requires the log message format described above in order to apply color highlighting automatically. The minimum required format is a log level name followed by a timestamp, and each log message must end with a newline character. For example, ``I (56): Log message\n``. If this format is not followed, such as when the timestamp is disabled, automatic log coloring will not work. In these cases, it is recommended to enable :ref:`CONFIG_LOG_COLORS` in the menuconfig. Another limitation is that for multi-line log messages, only the first line will be colored correctly.
- **Level Name**: A single letter (I, W, E, D, V) indicating log verbosity, displayed at the start of each message. Useful for identifying log levels, especially when color is disabled, as utilized by the ESP-IDF monitor tool.