[PATCH v2 3/3] Documentation for the --menutitle option

["Jiří ‘bindiff’ Wolker via Grub-devel" <grub-devel@gnu.org>]

---
 docs/grub.texi | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/docs/grub.texi b/docs/grub.texi
index 34b3484dc..5b5e40c49 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -1845,7 +1845,7 @@ definitions do not affect the exit status in @code{$?}.  When executed, the
 exit status of a function is the exit status of the last command executed in
 the body.
 
-@item menuentry @var{title} [@option{--class=class} @dots{}] [@option{--users=users}] [@option{--unrestricted}] [@option{--hotkey=key}] [@option{--id=id}] @{ @var{command}; @dots{} @}
+@item menuentry @var{title} [@option{--class=class} @dots{}] [@option{--users=users}] [@option{--unrestricted}] [@option{--hotkey=key}] [@option{--id=id}] [@option{--menutitle=text}] @{ @var{command}; @dots{} @}
 @xref{menuentry}.
 @end table
 
@@ -6034,7 +6034,7 @@ These commands can only be used in the menu:
 
 @deffn Command menuentry @var{title} @
  [@option{--class=class} @dots{}] [@option{--users=users}] @
- [@option{--unrestricted}] [@option{--hotkey=key}] [@option{--id=id}] @
+ [@option{--unrestricted}] [@option{--hotkey=key}] [@option{--id=id}] [@option{--menutitle=text}] @
  [@var{arg} @dots{}] @{ @var{command}; @dots{} @}
 This defines a GRUB menu entry named @var{title}.  When this entry is
 selected from the menu, GRUB will set the @var{chosen} environment variable
@@ -6060,6 +6060,13 @@ The @option{--id} may be used to associate unique identifier with a menu entry.
 @var{id} is string of ASCII aphanumeric characters, underscore and hyphen
 and should not start with a digit.
 
+The @option{--menutitle} can override the text displayed above the
+frame in which the menu is shown. This is useful especially for the
+@command{submenu}, which shares options with
+@command{menuentry}. Nested menus will inherit the menu title, unless
+explicitly replaces. Using an empty string causes the @var{title} of
+the option to be used as the menu title.
+
 All other arguments including @var{title} are passed as positional parameters
 when list of commands is executed with @var{title} always assigned to @code{$1}.
 @end deffn
@@ -6071,7 +6078,7 @@ when list of commands is executed with @var{title} always assigned to @code{$1}.
 @deffn Command submenu @var{title} @
  [@option{--class=class} @dots{}] [@option{--users=users}] @
  [@option{--unrestricted}] [@option{--hotkey=key}] [@option{--id=id}] @
- @{ @var{menu entries} @dots{} @}
+ [@option{--menutitle=text}] @{ @var{menu entries} @dots{} @}
 This defines a submenu.  An entry called @var{title} will be added to the
 menu; when that entry is selected, a new menu will be displayed showing all
 the entries within this submenu.
-- 
2.45.3


_______________________________________________
Grub-devel mailing list
Grub-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/grub-devel