Merge branch 'master' of git://git.denx.de/u-boot-blackfin

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

diff --git a/doc/README.menu b/doc/README.menu
index 1259c6ad578f4289d750aca2837f68d2991eba28..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"
@@ -69,6 +74,11 @@ int menu_get_choice(struct menu *m, void **choice);
  */
 int menu_destroy(struct menu *m);
 
+/*
+ * menu_display_statusline(struct menu *m);
+ * shows a statusline for every menu_display call.
+ */
+void menu_display_statusline(struct menu *m);
 
 Example Code
 ------------
@@ -97,7 +107,7 @@ char *pick_a_tool(void)
                        printf("failed to add item!");
                        menu_destroy(m);
                        return NULL;
-                }
+               }
        }
 
        if (menu_get_choice(m, (void **)&tool) != 1)