mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Ahmad Fatoum <a.fatoum@pengutronix.de>
To: barebox@lists.infradead.org
Cc: Ahmad Fatoum <a.fatoum@pengutronix.de>
Subject: [PATCH] include: barebox.h: document enum autoboot_state
Date: Mon, 21 Oct 2024 16:06:44 +0200	[thread overview]
Message-ID: <20241021140644.801593-1-a.fatoum@pengutronix.de> (raw)

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




             reply	other threads:[~2024-10-21 14:27 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-21 14:06 Ahmad Fatoum [this message]
2024-10-22  8:18 ` Sascha Hauer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241021140644.801593-1-a.fatoum@pengutronix.de \
    --to=a.fatoum@pengutronix.de \
    --cc=barebox@lists.infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox