From 8cb7c04248c9f0c3b79325b82844d79a680ef2eb Mon Sep 17 00:00:00 2001 From: Simon Glass Date: Thu, 28 Dec 2017 13:14:22 -0700 Subject: [PATCH] log: Add documentation for commands and formatting Add some notes about recent new features. Signed-off-by: Simon Glass --- doc/README.log | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/doc/README.log b/doc/README.log index f653fe7d79..54d9a8e1b9 100644 --- a/doc/README.log +++ b/doc/README.log @@ -68,6 +68,19 @@ If CONFIG_LOG is not set, then no logging will be available. The above have SPL versions also, e.g. CONFIG_SPL_MAX_LOG_LEVEL. +Log commands +------------ + +The 'log' command provides access to several features: + + level - access the default log level + format - access the console log format + rec - output a log record + test - run tests + +Type 'help log' for details. + + Using DEBUG ----------- @@ -94,6 +107,20 @@ enabled or disabled independently: console - goes to stdout +Log format +---------- + +You can control the log format using the 'log format' command. The basic +format is: + + LEVEL.category,file.c:123-func() message + +In the above, file.c:123 is the filename where the log record was generated and +func() is the function name. By default ('log format default') only the +function name and message are displayed on the console. You can control which +fields are present, but not the field order. + + Filters ------- -- 2.39.5