U-Boot Archive on lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH 1/1] sandbox: fix enum host_platform_flags description
@ 2026-07-27 17:00 Heinrich Schuchardt via U-Boot
  2026-07-27 17:29 ` Denis Mukhin via U-Boot
  0 siblings, 1 reply; 2+ messages in thread
From: Heinrich Schuchardt via U-Boot @ 2026-07-27 17:00 UTC (permalink / raw)
  To: Simon Glass; +Cc: Tom Rini, Denis Mukhin, u-boot, Heinrich Schuchardt

`make htmldocs` reports

    ./include/sandbox_host.h:14: warning:
    cannot understand function prototype: 'enum host_platform_flags '

Align the description with Sphinx style.

Fixes: 93e9af685fef ("test: bootdev: scan with a broken high-priority device")
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
 include/sandbox_host.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/include/sandbox_host.h b/include/sandbox_host.h
index 1330358ef7a..8329cbba537 100644
--- a/include/sandbox_host.h
+++ b/include/sandbox_host.h
@@ -9,10 +9,12 @@
 #define __SANDBOX_HOST__
 
 /**
- * Device flags.
+ * enum host_platform_flags - device flags
+ *
  */
 enum host_platform_flags {
-	HOST_FLAG_BROKEN		= BIT(0), /** Simulate broken device */
+	/** @HOST_FLAG_BROKEN:	simulate boken device */
+	HOST_FLAG_BROKEN		= BIT(0),
 };
 
 /**
-- 
2.53.0


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH 1/1] sandbox: fix enum host_platform_flags description
  2026-07-27 17:00 [PATCH 1/1] sandbox: fix enum host_platform_flags description Heinrich Schuchardt via U-Boot
@ 2026-07-27 17:29 ` Denis Mukhin via U-Boot
  0 siblings, 0 replies; 2+ messages in thread
From: Denis Mukhin via U-Boot @ 2026-07-27 17:29 UTC (permalink / raw)
  To: Heinrich Schuchardt; +Cc: Simon Glass, Tom Rini, Denis Mukhin, u-boot

On Mon, Jul 27, 2026 at 07:00:22PM +0200, Heinrich Schuchardt via U-Boot wrote:
> `make htmldocs` reports
> 
>     ./include/sandbox_host.h:14: warning:
>     cannot understand function prototype: 'enum host_platform_flags '
> 
> Align the description with Sphinx style.
> 
> Fixes: 93e9af685fef ("test: bootdev: scan with a broken high-priority device")
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>

Thanks for the fix!

> ---
>  include/sandbox_host.h | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/include/sandbox_host.h b/include/sandbox_host.h
> index 1330358ef7a..8329cbba537 100644
> --- a/include/sandbox_host.h
> +++ b/include/sandbox_host.h
> @@ -9,10 +9,12 @@
>  #define __SANDBOX_HOST__
>  
>  /**
> - * Device flags.
> + * enum host_platform_flags - device flags
> + *
>   */
>  enum host_platform_flags {
> -	HOST_FLAG_BROKEN		= BIT(0), /** Simulate broken device */
> +	/** @HOST_FLAG_BROKEN:	simulate boken device */

                                     ^^ typo

With typo fixed:

Reviewed-by: Denis Mukhin <dmukhin@ford.com> 


> +	HOST_FLAG_BROKEN		= BIT(0),
>  };
>  
>  /**
> -- 
> 2.53.0
> 

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-07-27 17:29 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-07-27 17:00 [PATCH 1/1] sandbox: fix enum host_platform_flags description Heinrich Schuchardt via U-Boot
2026-07-27 17:29 ` Denis Mukhin via U-Boot

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox