common, menu: show menu on startup if CONFIG_MENU_SHOW is defined

[karo-tx-uboot.git] / doc / README.menu

diff --git a/doc/README.menu b/doc/README.menu
index 4ddf91491dab781908cfaf0db402a762b12880f3..6ce6bbab80728db810d75196e0c5615b4e9efb0a 100644 (file)
--- a/doc/README.menu
+++ b/doc/README.menu
@@ -25,6 +25,11 @@ the interfaces should be available.
 Menus are composed of items. Each item has a key used to identify it in
 the menu, and an opaque pointer to data controlled by the consumer.
 
+If you want to show a menu, instead starting the shell, define
+CONFIG_MENU_SHOW. You have to code the int menu_show(int bootdelay)
+function, which handle your menu. This function returns the remaining
+bootdelay.
+
 Interfaces
 ----------
 #include "menu.h"