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 <[email protected]> --- 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
