Skip to contentSkip to conversation

log: Tidy up documentation

PATCH New Simon Glass 2 participants 3 messages Oct 14, 2020 – Oct 23, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 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")

---

 doc/develop/logging.rst | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)
doc/develop/logging.rst +8 -5
index 7ce8482ab6d..28340a4aac7 100644
@@ -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.
 
 
Signature · 1 line
2.28.0.1011.ga647a8990f-goog
#1 lore raw

PATCH 1/1 log: Tidy up documentation

Quoted 6 lines · Simon Glass

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")

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20201022/8b79889b/attachment.sig>
#2 lore raw

PATCH 1/1 log: Tidy up documentation

In reply to Simon Glass
Quoted 6 lines · Simon Glass

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")

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20201022/690e3811/attachment.sig>