Re: [PATCH] Document menuentry --id option

[Andrey Borzenkov <arvidjaar@gmail.com>]

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

В Sun, 20 Jan 2013 23:51:46 +0100
Vladimir 'φ-coder/phcoder' Serbinenko <phcoder@gmail.com> пишет:

> >  @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.
> 

I understand that, but you still need to explain what happens when --id
is not given. Or make it mandatory argument.

> >  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_]*

It is not what grub currently does :) Do you really mean underscore?
Grub is currently using hyphen.

> (while arbitrary string would work it's not a good idea.
> 

Sure, but again - it can be arbitrary string. Nothing restricts
character set used. My goal is to document current grub behavior. Lying
about what it does just adds to confusion. I'm fine with adding "it is
recommended to restrict value @var{id} to alphanumeric ASCII
characters, hyphen and underscore for portability".

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]