Djam/u-boot
1
0
Fork 0
mirror of https://github.com/u-boot/u-boot.git synced 2025-04-21 20:34:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: fix doc/develop/logging.rst

Browse source 
Sphinx 3 builds fail due to doc/develop/logging.rst producing duplicate
labels.

Include logging.h only once in the API section and use cross-references for
the enums log_level_t and log_category_t.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
This commit is contained in:
Heinrich Schuchardt 2021-01-25 21:06:57 +01:00
parent c7d2b2ccd3
commit a6aaeb2a91
3 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/api/index.rst
View file

@ -10,6 +10,7 @@ U-Boot API documentation
efi efi
getopt getopt
linker_lists linker_lists
logging
pinctrl pinctrl
rng rng
sandbox sandbox

6
doc/api/logging.rst Normal file
View file

@ -0,0 +1,6 @@
.. SPDX-License-Identifier: GPL-2.0+
Logging API
===========
.. kernel-doc:: include/log.h

13
doc/develop/logging.rst
View file

@ -26,8 +26,7 @@ Logging levels
There are a number logging levels available. There are a number logging levels available.
.. kernel-doc:: include/log.h See enum :c:type:`log_level_t`
:identifiers: log_level_t
Logging category Logging category
---------------- ----------------
@ -36,8 +35,7 @@ Logging can come from a wide variety of places within U-Boot. Each log message
has a category which is intended to allow messages to be filtered according to has a category which is intended to allow messages to be filtered according to
their source. their source.
.. kernel-doc:: include/log.h See enum :c:type:`log_category_t`
:identifiers: log_category_t
Enabling logging Enabling logging
---------------- ----------------
@ -67,7 +65,7 @@ to enable building in of all logging statements in a single file. Put it at
the top of the file, before any #includes. the top of the file, before any #includes.
To actually get U-Boot to output this you need to also set the default logging 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 (:c:type:`LOGL_DEBUG`) or more. level - e.g. set CONFIG_LOG_DEFAULT_LEVEL to 7 (:c:data:`LOGL_DEBUG`) or more.
Otherwise debug output is suppressed and will not be generated. Otherwise debug output is suppressed and will not be generated.
Using DEBUG Using DEBUG
@ -290,8 +288,3 @@ number dropped due to them being generated before the log system was ready.
Add a printf() format string pragma so that log statements are checked properly Add a printf() format string pragma so that log statements are checked properly
Add a command to delete existing log records. Add a command to delete existing log records.
Logging API
-----------
.. kernel-doc:: include/log.h
:internal: