[U-Boot,v2,16/18] autoboot: Add comments for menu_show()
diff mbox series

Message ID 20190721025128.30351-17-sjg@chromium.org
State Accepted
Delegated to: Tom Rini
Headers show
Series
  • autoboot: Tidy up autoboot code
Related show

Commit Message

Simon Glass July 21, 2019, 2:51 a.m. UTC
Add comments for this function. Also remove the #ifdef around it so that
it can be called from 'if (IS_ENABLED(...))'.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

Changes in v2: None

 include/menu.h | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

Patch
diff mbox series

diff --git a/include/menu.h b/include/menu.h
index 8fd7b0a1f0..2d227c20bd 100644
--- a/include/menu.h
+++ b/include/menu.h
@@ -19,7 +19,20 @@  int menu_destroy(struct menu *m);
 void menu_display_statusline(struct menu *m);
 int menu_default_choice(struct menu *m, void **choice);
 
-#if defined(CONFIG_AUTOBOOT_MENU_SHOW)
+/**
+ * menu_show() Show a boot menu
+ *
+ * This shows a menu and lets the user select an option. The menu is defined by
+ * environment variables (see README.bootmenu).
+ *
+ * This function doesn't normally return, but if the users requests the command
+ * problem, it will.
+ *
+ * @bootdelay: Delay to wait before running the default menu option (0 to run
+ *		the entry immediately)
+ * @return If it returns, it always returns -1 to indicate that the boot should
+ *	be aborted and the command prompt should be provided
+ */
 int menu_show(int bootdelay);
-#endif
+
 #endif /* __MENU_H__ */