leandrof/u-boot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

log: Add documentation for convenience functions

Browse Source 
The log_debug(), etc. function are documented only in the header file at
present. Add a section to README.log also.

Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
This commit is contained in:
Simon Glass 2019-02-16 20:24:36 -07:00 committed by Bin Meng
parent f0b05c95e3
commit 8dee7b96fd
1 changed files with 26 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/README.log
View File

@ -69,6 +69,32 @@ 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.
Convenience functions
---------------------
A number of convenience functions are available to shorten the code needed
for logging:
log_err(_fmt...)
log_warning(_fmt...)
log_notice(_fmt...)
log_info(_fmt...)
log_debug(_fmt...)
log_content(_fmt...)
log_io(_fmt...)
With these the log level is implicit in the name. The category is set by
LOG_CATEGORY, which you can only define once per file, above all #includes:
#define LOG_CATEGORY LOGC_ALLOC
or
#define LOG_CATEGORY UCLASS_SPI
Remember that all uclasses IDs are log categories too.
Log commands
------------
@ -187,16 +213,6 @@ Convenience functions to support setting the category:
log_core(level, format_string, ...) - category LOGC_CORE
log_dt(level, format_string, ...) - category LOGC_DT
Convenience functions to support a category defined for a single file, for
example:
#define LOG_CATEGORY UCLASS_USB
all of these can use LOG_CATEGORY as the category, and a log level
corresponding to the function name:
logc(level, format_string, ...)
More logging destinations:
device - goes to a device (e.g. serial)