[PATCH 09/12] log: Fix the comment for struct log_driver()

Heinrich Schuchardt xypron.glpk at gmx.de
Mon Sep 28 03:47:30 CEST 2020


Am 28. September 2020 02:46:21 MESZ schrieb Simon Glass <sjg at chromium.org>:
>This is missing a comment for the 'emit' member. Add it.
>
>Signed-off-by: Simon Glass <sjg at chromium.org>
>---
>
> include/log.h | 1 +
> 1 file changed, 1 insertion(+)
>
>diff --git a/include/log.h b/include/log.h
>index dc1b6b5e4c6..b49f5c99859 100644
>--- a/include/log.h
>+++ b/include/log.h
>@@ -304,6 +304,7 @@ struct log_device;
> * struct log_driver - a driver which accepts and processes log records
>  *
>  * @name: Name of driver
>+ * @emit: Method to call to emit a log record via this device
>  */
> struct log_driver {
> 	const char *name;

log.h seems to be missing in the generated HTML documentation. Cf https://u-boot.readthedocs.io/en/latest/api/index.html

If we add it, make htmldocs will warn us of similar glitches.

Best regards

Heinrich



More information about the U-Boot mailing list