mail archive of the barebox mailing list
 help / color / mirror / Atom feed
* [PATCH] include: barebox.h: document enum autoboot_state
@ 2024-10-21 14:06 Ahmad Fatoum
  2024-10-22  8:18 ` Sascha Hauer
  0 siblings, 1 reply; 2+ messages in thread
From: Ahmad Fatoum @ 2024-10-21 14:06 UTC (permalink / raw)
  To: barebox; +Cc: Ahmad Fatoum

Only documentation we have for this is the magic var help string, so
let's have some more words to go along with it in the code.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 include/barebox.h | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/include/barebox.h b/include/barebox.h
index 741463bc1cf9..45e95f187462 100644
--- a/include/barebox.h
+++ b/include/barebox.h
@@ -18,6 +18,17 @@ void __noreturn hang (void);
  */
 extern int (*barebox_main)(void);
 
+/**
+ * enum autoboot_state - autoboot action after init
+ * @AUTOBOOT_COUNTDOWN: Count down to automatic boot action
+ * @AUTOBOOT_ABORT: Abort boot and drop to barebox shell
+ * AUTOBOOT_MENU: Show main menu directly
+ * @AUTOBOOT_BOOT: Boot right away without an interruptible countdown
+ * @AUTOBOOT_UNKNOWN: Boot right away without an interruptible countdown
+ *
+ * This enum descibes what action to take after barebox initialization
+ * has completed and it's time to boot.
+ */
 enum autoboot_state {
 	AUTOBOOT_COUNTDOWN,
 	AUTOBOOT_ABORT,
-- 
2.39.5




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

* Re: [PATCH] include: barebox.h: document enum autoboot_state
  2024-10-21 14:06 [PATCH] include: barebox.h: document enum autoboot_state Ahmad Fatoum
@ 2024-10-22  8:18 ` Sascha Hauer
  0 siblings, 0 replies; 2+ messages in thread
From: Sascha Hauer @ 2024-10-22  8:18 UTC (permalink / raw)
  To: barebox, Ahmad Fatoum


On Mon, 21 Oct 2024 16:06:44 +0200, Ahmad Fatoum wrote:
> Only documentation we have for this is the magic var help string, so
> let's have some more words to go along with it in the code.
> 
> 

Applied, thanks!

[1/1] include: barebox.h: document enum autoboot_state
      https://git.pengutronix.de/cgit/barebox/commit/?id=80b5e969e0d6 (link may not be stable)

Best regards,
-- 
Sascha Hauer <s.hauer@pengutronix.de>




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

end of thread, other threads:[~2024-10-22  8:19 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-10-21 14:06 [PATCH] include: barebox.h: document enum autoboot_state Ahmad Fatoum
2024-10-22  8:18 ` Sascha Hauer

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