log: Tidy up documentation
authorSimon Glass <sjg@chromium.org>
Wed, 14 Oct 2020 01:55:07 +0000 (19:55 -0600)
committerTom Rini <trini@konsulko.com>
Thu, 22 Oct 2020 15:26:14 +0000 (11:26 -0400)
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>
doc/develop/logging.rst

index 7ce8482..28340a4 100644 (file)
@@ -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.