Re: [PATCH] Document menuentry --id option

["Vladimir 'φ-coder/phcoder' Serbinenko" <phcoder@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 3105 bytes --]

On 18.09.2012 18:53, Andrey Borzenkov wrote:

> 
> === modified file 'ChangeLog'
> --- old/ChangeLog	2012-09-18 11:04:06 +0000
> +++ new/ChangeLog	2012-09-18 16:28:12 +0000
> @@ -1,3 +1,7 @@
> +2012-09-18  Andrey Borzenkov  <arvidjaar@gmail.com>
> +
> +	* docs/grub.texi: Document menuentry --id option.
> +
>  2012-09-18  Vladimir Serbinenko  <phcoder@gmail.com>
>  
>  	* util/grub-mkconfig_lib.in (grub_tab): New variable.
> 
> === modified file 'docs/grub.texi'
> --- old/docs/grub.texi	2012-07-31 22:18:57 +0000
> +++ new/docs/grub.texi	2012-09-18 16:02:26 +0000
> @@ -1502,7 +1502,7 @@
>  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}] @{ @var{command}; @dots{} @}
> +@item menuentry @var{title} [@option{--class=class} @dots{}] [@option{--users=users}] [@option{--unrestricted}] [@option{--hotkey=key}] [@option{--id=id}] @{ @var{command}; @dots{} @}
>  @xref{menuentry}.
>  @end table
>  
> @@ -3114,11 +3114,12 @@
>  
>  @deffn Command menuentry @var{title} @
>   [@option{--class=class} @dots{}] [@option{--users=users}] @
> - [@option{--unrestricted}] [@option{--hotkey=key}] @
> + [@option{--unrestricted}] [@option{--hotkey=key}] [@option{--id=id}] @
>   @{ @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
> -to @var{title}, execute the list of commands given within braces, and if the
> +to value of @option{--id} or @var{title} if @option{--id} is not given,
> +execute the list of commands given within braces, and if the

It's better to not mention the possible usage of title for this at all.
Ehile it's kept for backward compatibility it has problems when language
or disk name changes and hence discouraged.

>  last command in the list returned successfully and a kernel was loaded it
>  will execute the @command{boot} command.
>  
> @@ -3135,6 +3136,9 @@
>  The @option{--hotkey} option associates a hotkey with a menu entry.
>  @var{key} may be a single letter, or one of the aliases @samp{backspace},
>  @samp{tab}, or @samp{delete}.
> +
> +The @option{--id} may be used to associate unique identifier with a menu entry.
> +@var{id} is arbitrary string.

It has to be
[a-zA-Z_][0-9a-zA-Z_]*
(while arbitrary string would work it's not a good idea.

>  @end deffn
>  
>  
> @@ -3143,7 +3147,7 @@
>  
>  @deffn Command submenu @var{title} @
>   [@option{--class=class} @dots{}] [@option{--users=users}] @
> - [@option{--unrestricted}] [@option{--hotkey=key}] @
> + [@option{--unrestricted}] [@option{--hotkey=key}] [@option{--id=id}] @
>   @{ @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
> 



-- 
Regards
Vladimir 'φ-coder/phcoder' Serbinenko


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 294 bytes --]