a5bd9f6
From f15f2bd2977f88231e5c4ae718421360129c889d Mon Sep 17 00:00:00 2001
a5bd9f6
From: Andrey Borzenkov  <arvidjaar@gmail.com>
a5bd9f6
Date: Fri, 5 Apr 2013 10:08:20 +0200
a5bd9f6
Subject: [PATCH 256/364] 	* docs/grub.texi: Document menuentry --id
a5bd9f6
 option.
a5bd9f6
a5bd9f6
---
a5bd9f6
 ChangeLog      |  4 ++++
a5bd9f6
 docs/grub.texi | 16 ++++++++++------
a5bd9f6
 2 files changed, 14 insertions(+), 6 deletions(-)
a5bd9f6
a5bd9f6
diff --git a/ChangeLog b/ChangeLog
a5bd9f6
index f2c2d2f..6113a39 100644
a5bd9f6
--- a/ChangeLog
a5bd9f6
+++ b/ChangeLog
a5bd9f6
@@ -1,3 +1,7 @@
a5bd9f6
+2013-04-04  Andrey Borzenkov  <arvidjaar@gmail.com>
a5bd9f6
+
a5bd9f6
+	* docs/grub.texi: Document menuentry --id option.
a5bd9f6
+
a5bd9f6
 2013-04-04  Francesco Lavra  <francescolavra.fl@gmail.com>
a5bd9f6
 
a5bd9f6
 	* util/grub-mkimage.c: Introduce new define EFI32_HEADER_SIZE.
a5bd9f6
diff --git a/docs/grub.texi b/docs/grub.texi
a5bd9f6
index 0b66827..742d406 100644
a5bd9f6
--- a/docs/grub.texi
a5bd9f6
+++ b/docs/grub.texi
a5bd9f6
@@ -1522,7 +1522,7 @@ definitions do not affect the exit status in @code{$?}.  When executed, the
a5bd9f6
 exit status of a function is the exit status of the last command executed in
a5bd9f6
 the body.
a5bd9f6
 
a5bd9f6
-@item menuentry @var{title} [@option{--class=class} @dots{}] [@option{--users=users}] [@option{--unrestricted}] [@option{--hotkey=key}] @{ @var{command}; @dots{} @}
a5bd9f6
+@item menuentry @var{title} [@option{--class=class} @dots{}] [@option{--users=users}] [@option{--unrestricted}] [@option{--hotkey=key}] [@option{--id=id}] @{ @var{command}; @dots{} @}
a5bd9f6
 @xref{menuentry}.
a5bd9f6
 @end table
a5bd9f6
 
a5bd9f6
@@ -3215,13 +3215,13 @@ These commands can only be used in the menu:
a5bd9f6
 
a5bd9f6
 @deffn Command menuentry @var{title} @
a5bd9f6
  [@option{--class=class} @dots{}] [@option{--users=users}] @
a5bd9f6
- [@option{--unrestricted}] [@option{--hotkey=key}] @
a5bd9f6
+ [@option{--unrestricted}] [@option{--hotkey=key}] [@option{--id=id}] @
a5bd9f6
  @{ @var{command}; @dots{} @}
a5bd9f6
 This defines a GRUB menu entry named @var{title}.  When this entry is
a5bd9f6
 selected from the menu, GRUB will set the @var{chosen} environment variable
a5bd9f6
-to @var{title}, execute the list of commands given within braces, and if the
a5bd9f6
-last command in the list returned successfully and a kernel was loaded it
a5bd9f6
-will execute the @command{boot} command.
a5bd9f6
+to value of @option{--id} if @option{--id} is given, execute the list of
a5bd9f6
+commands given within braces, and if the last command in the list returned
a5bd9f6
+successfully and a kernel was loaded it will execute the @command{boot} command.
a5bd9f6
 
a5bd9f6
 The @option{--class} option may be used any number of times to group menu
a5bd9f6
 entries into classes.  Menu themes may display different classes using
a5bd9f6
@@ -3236,6 +3236,10 @@ entries.  @xref{Security}.
a5bd9f6
 The @option{--hotkey} option associates a hotkey with a menu entry.
a5bd9f6
 @var{key} may be a single letter, or one of the aliases @samp{backspace},
a5bd9f6
 @samp{tab}, or @samp{delete}.
a5bd9f6
+
a5bd9f6
+The @option{--id} may be used to associate unique identifier with a menu entry.
a5bd9f6
+@var{id} is string of ASCII aphanumeric characters, underscore and hyphen
a5bd9f6
+and should not start with a digit.
a5bd9f6
 @end deffn
a5bd9f6
 
a5bd9f6
 
a5bd9f6
@@ -3244,7 +3248,7 @@ The @option{--hotkey} option associates a hotkey with a menu entry.
a5bd9f6
 
a5bd9f6
 @deffn Command submenu @var{title} @
a5bd9f6
  [@option{--class=class} @dots{}] [@option{--users=users}] @
a5bd9f6
- [@option{--unrestricted}] [@option{--hotkey=key}] @
a5bd9f6
+ [@option{--unrestricted}] [@option{--hotkey=key}] [@option{--id=id}] @
a5bd9f6
  @{ @var{menu entries} @dots{} @}
a5bd9f6
 This defines a submenu.  An entry called @var{title} will be added to the
a5bd9f6
 menu; when that entry is selected, a new menu will be displayed showing all
a5bd9f6
-- 
a5bd9f6
1.8.1.4
a5bd9f6