Mirrors/u-boot
2
0
Fork 0
mirror of https://github.com/AsahiLinux/u-boot synced 2024-11-24 21:54:01 +00:00
Code Issues Projects Releases Packages Wiki Activity

autoboot: Add comments for menu_show()

Browse source 
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>
This commit is contained in:
Simon Glass 2019-07-20 20:51:26 -06:00 committed by Tom Rini
parent cf9803a60b
commit 14b9df1b48
1 changed files with 15 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
include/menu.h
View file

@ -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__ */