log: Add documentation for commands and formatting

Add some notes about recent new features. Signed-off-by: Simon Glass <sjg@chromium.org>

log: Add documentation for commands and formatting
Add some notes about recent new features. Signed-off-by: Simon Glass <sjg@chromium.org>
Simon Glass
1 parent aa4e0e005b
Showing 1 changed file with 27 additions and 0 deletions Side-by-side Diff
doc/README.log
@@ -68,6 +68,19 @@
 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
 -----------
  
@@ -92,6 +105,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
...	...	@@ -68,6 +68,19 @@
68	68	The above have SPL versions also, e.g. CONFIG_SPL_MAX_LOG_LEVEL.
69	69
70	70
	71	+Log commands
	72	+------------
	73	+
	74	+The 'log' command provides access to several features:
	75	+
	76	+ level - access the default log level
	77	+ format - access the console log format
	78	+ rec - output a log record
	79	+ test - run tests
	80	+
	81	+Type 'help log' for details.
	82	+
	83	+
71	84	Using DEBUG
72	85	-----------
73	86
...	...	@@ -92,6 +105,20 @@
92	105	enabled or disabled independently:
93	106
94	107	console - goes to stdout
	108	+
	109	+
	110	+Log format
	111	+----------
	112	+
	113	+You can control the log format using the 'log format' command. The basic
	114	+format is:
	115	+
	116	+ LEVEL.category,file.c:123-func() message
	117	+
	118	+In the above, file.c:123 is the filename where the log record was generated and
	119	+func() is the function name. By default ('log format default') only the
	120	+function name and message are displayed on the console. You can control which
	121	+fields are present, but not the field order.
95	122
96	123
97	124	Filters