diff options
| author | Simon Glass | 2020-10-13 19:55:07 -0600 |
|---|---|---|
| committer | Tom Rini | 2020-10-22 11:26:14 -0400 |
| commit | 7ad1e0bcf3dad761c53b97e94a6860d090f5a352 (patch) | |
| tree | cc7351cb7ecb200ca3cb9efdfa5804ac5c6f5e0d | |
| parent | ef38b42364515d138cb8bea82c23d36ceac8fd71 (diff) | |
log: Tidy up documentation
Fix up the documentation which was lost in a merge conflict in the
conversion to RST.
Fixes: 52d3df7fefe ("log: Allow LOG_DEBUG to always enable log output")
Signed-off-by: Simon Glass <sjg@chromium.org>
| -rw-r--r-- | doc/develop/logging.rst | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/develop/logging.rst b/doc/develop/logging.rst index 7ce8482ab6d..28340a4aac7 100644 --- a/doc/develop/logging.rst +++ b/doc/develop/logging.rst @@ -83,11 +83,8 @@ Sometimes it is useful to turn on logging just in one file. You can use this #define LOG_DEBUG to enable building in of all logging statements in a single file. Put it at -the top of the file, before any #includes. - -To actually get U-Boot to output this you need to also set the default logging -level - e.g. set CONFIG_LOG_DEFAULT_LEVEL to 7 (LOGL_DEBUG) or more. Otherwise -debug output is suppressed and will not be generated. +the top of the file, before any #includes. This overrides any log-level setting +in U-Boot, including CONFIG_LOG_DEFAULT_LEVEL, but just for that file. Convenience functions @@ -111,6 +108,12 @@ LOG_CATEGORY, which you can only define once per file, above all #includes, e.g. #define LOG_CATEGORY LOGC_ALLOC +or + +.. code-block:: c + + #define LOG_CATEGORY UCLASS_SPI + Remember that all uclasses IDs are log categories too. |