Re: Command documentation part 1.

[Francesco Lavra <francescolavra.fl@gmail.com>]

Hi,

On 01/29/2013 11:25 AM, Andrey Borzenkov wrote:
> В Tue, 22 Jan 2013 17:12:18 +0000
> Colin Watson <cjwatson@ubuntu.com> пишет:
> 
>> On Tue, Jan 22, 2013 at 05:08:51PM +0400, Andrey Borzenkov wrote:
>>> Quit a number of commands are not documented. Is it intentional
>>> (because they are not considered "user level API")? Should
>>> documentation for them go into grub or grub-dev?
>>
>> I spent some time documenting the list of commands a while back, but I
>> never completed the project: what you're seeing is simply how far I got
>> before getting distracted by other things.  IMO all commands should be
>> documented in grub.texi.
>>
> 
> Below is attempt to document most of user-relevant commands (I may have
> missed a couple of them). Please review (formatting, language).
> 
> What is left are
> 
> - new file signature checks. I need some time to understand how to
>   describe them
> 
> - non-Linux loaders. I do not have experience myself, so it will need
>   some help probably
> 
> - the rest of commands which are more or less low-level, not normally
>   expected to be used daily. I have the following suggestion:
> 
> * merge General commands and Command-line and menu entry commands into
>   General commands. Current split seems to be artificial. Let normal
>   user commands go into this section
> 
> * Add Advanced commands section where all the more exotic ones are described.
> 
>   Does it make sense?
> 
> Patch follows
> 
> From: Andrey Borzenkov <arvidjaar@gmail.com>
> Subject: [PATCH] document grub commands
> 
> Add documentation for grub commands
> 
> Signed-off-by: Andrey Borzenkov <arvidjaar@gmail.com>
> 
> ---
>  docs/grub.texi |  262 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 259 insertions(+), 3 deletions(-)
> 
> diff --git a/docs/grub.texi b/docs/grub.texi
> index 9941b47..8329ee1 100644
> --- a/docs/grub.texi
> +++ b/docs/grub.texi
[...]
> +@node background_image
> +@subsection background_image
> +
> +@deffn Command background_image [[@option{--mode} @samp{stretch}|@samp{normal}] file]
> +Load background image for active terminal from @var{file}. Image is stretched
> +to fill up entire screen unless option @option{--mode} @samp{normal} is given.
> +Without agruments remove currently loaded background image.

s/agruments/arguments

[...]
> +@node cryptomount
> +@subsection cryptomount
> +
> +@deffn Command cryptomount device|@option{-u} uuid|@option{-a}|@option{-b}
> +Setup access to encrypted device. If neccessary, passphrase

s/neccessary/necessary

[...]
> +@node sleep
> +@subsection sleep
> +
> +@deffn Command sleep [@option{--verbose}] [@option{--interruptible}] count
> +Sleep for @var{count} of seconds. If option @option{--interruptible} is given,

The word "of" should be removed (Sleep for @var{count} seconds.)

> +allow @key{ESC} to interrupt sleep. With @option{--verbose} show countdown
> +of remaining seconds.
> +@end deffn
> +
> +
>  @node source
>  @subsection source
>  
> @@ -4147,6 +4318,74 @@ will not be shown immediately.
>  @end deffn
>  
>  
> +@node test
> +@subsection test
> +
> +@deffn Command test expression
> +Evaluate @var{expression} and return zero exit status if result is true,
> +non zero status otherwise.
> +
> +@var{expression} is one of:
> +
> +@table @asis
> +@item @var{string1} @code{==} @var{string2}
> +the strings are equal
> +@item @var{string1} @code{!=} @var{string2}
> +the strings are not equal
> +@item @var{string1} @code{<} @var{string2}
> +@var{string1} is lexicographically less than @var{string2}
> +@item @var{string1} @code{<=} @var{string2}
> +@var{string1} is lexicographically less or equal than @var{string2}
> +@item @var{string1} @code{>} @var{string2}
> +@var{string1} is lexicographically greater than @var{string2}
> +@item @var{string1} @code{<=} @var{string2}

<= should be >=

> +@var{string1} is lexicographically greater or equal than @var{string2}
[...]
> +@node videoinfo
> +@subsection videoinfo
> +
> +@deffn Command videoinfo [[WxH]xD]
> +List available video modes. If resolution is given, show only mathing modes.

s/mathing/matching

Regards,
Francesco