log: Add documentation for commands and formatting
authorSimon Glass <sjg@chromium.org>
Thu, 28 Dec 2017 20:14:22 +0000 (13:14 -0700)
committerSimon Glass <sjg@chromium.org>
Sat, 3 Feb 2018 17:09:27 +0000 (10:09 -0700)
Add some notes about recent new features.

Signed-off-by: Simon Glass <sjg@chromium.org>
doc/README.log

index f653fe7d79711945855a9c25b8e3ffa2ecf55898..54d9a8e1b90ea4f13418390522c49a6b86ed113d 100644 (file)
@@ -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
 -------