Re: [PATCH] doc: document config_directory and config_file variables

["Arbiel (gmx)" <arbiel.perlacremaz@gmx.fr>]

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

Hi

There seems to be other variables and command parameters which lack
documentation.

Here is a list of such variables found in my grub.cfg files (I have
discarded "save_env"ed variables, obviously environment variables) and
which are not set in the environment block

${feature_menuentry_id}
${boot_once}
$feature_all_video_module
$feature_default_font_path
$feature_platform_search_hint
$feature_timeout_style
$match

As the names suggest, these variables could be distribution specific
(Ubuntu). What do you think ?

undocumented command parameter : --hint (command search), and some other
--hint.something which I haven't been able to localise just now.

I found in my grub.cfg file a "hwmatch" command which is not defifed as
a function. Is this a undocumented grub command ? Its result may well
the  $match variable.


Le 07/11/2015 11:21, Andrey Borzenkov a écrit :
> People are using this variable and it should be documented.
>
> ---
>  docs/grub.texi | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
>
> diff --git a/docs/grub.texi b/docs/grub.texi
> index b9f41a7..db765a3 100644
> --- a/docs/grub.texi
> +++ b/docs/grub.texi
> @@ -3038,6 +3038,8 @@ These variables have special meaning to GRUB.
>  * cmdpath::
>  * color_highlight::
>  * color_normal::
> +* config_directory::
> +* config_file::
>  * debug::
>  * default::
>  * fallback::
> @@ -3180,6 +3182,22 @@ matching colors of first half.
>  to support whole rgb24 palette but currently there is no compelling reason
>  to go beyond the current 16 colors.
>  
> +
> +@node config_directory
> +@subsection config_directory
> +
> +This variable is automatically set by GRUB to the directory part of
> +current configuration file name (@pxref{config_file}).
> +
> +
> +@node config_file
> +@subsection config_file
> +
> +This variable is automatically set by GRUB to the name of configuration file that is being
> +processed by commands @command{configfile} (@pxref{configfile}) or @command{normal}
> +(@pxref{normal}).  It is restored to the previous value when command completes.
> +
> +
>  @node debug
>  @subsection debug
>  



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