doc: document config_directory and config_file variables
PATCH 1/1 doc: document config_directory and config_file variables
People are using this variable and it should be documented.
--- docs/grub.texi | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+)
docs/grub.texi +18 -0
@@ -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
Signature · 1 line
tg: (c1fbc26..) u/config_directory (depends on: master)
Go ahead
Quoted 53 lines · Andrey Borzenkov
People are using this variable and it should be documented.
--- docs/grub.texi | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+)docs/grub.texi +14
-0@@ -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 configurationfile 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.docs/grub.texi +2
-1+ + @node debug @subsection debug --tg: (c1fbc26..) u/config_directory (depends on: master)
_______________________________________________
Grub-devel mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/grub-devel
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.
Quoted 42 lines · Andrey Borzenkov
People are using this variable and it should be documented.
--- docs/grub.texi | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+)docs/grub.texi +18
-0@@ -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
07.11.2015 22:51, Arbiel (gmx) пишет:
Quoted 9 lines
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
Quoted 6 lines
${feature_menuentry_id}
${boot_once}
$feature_all_video_module
$feature_default_font_path
$feature_platform_search_hint
$feature_timeout_style
I do not not think any of them need to be documented in user manual. Features are of interest to developers to ensure backward compatibility; users start off with a given version and need not usually care if it works in earlier ones. $boot_once is internal implementation variable that is of no interest to anyone and its purpose is obvious by reading script.
It's fine to describe them in developers documentation of course, but so far nobody volunteered to maintain it.
Quoted 8 lines
$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.
Which command?
Quoted 4 lines
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.
Both are Ubuntu (or may be Debian) specific.
Quoted 29 lines · Andrei Borzenkov
07.11.2015 22:51, Arbiel (gmx) пишет:
Quoted 9 lines
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
Quoted 6 lines
${feature_menuentry_id}
${boot_once}
$feature_all_video_module
$feature_default_font_path
$feature_platform_search_hint
$feature_timeout_styleI do not not think any of them need to be documented in user manual. Features are of interest to developers to ensure backward compatibility; users start off with a given version and need not usually care if it works in earlier ones. $boot_once is internal implementation variable that is of no interest to anyone and its purpose is obvious by reading script.
It's fine to describe them in developers documentation of course, but so far nobody volunteered to maintain it.
Quoted 2 lines
$match
Quoted 8 lines
Quoted 6 lines
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.
Which command?
search.
And I just read in a grub.cfg file, not one of mine the line
search --no-floppy --fs-uuid --set=root --hint-bios=hd0,gpt6 --hint-efi=hd0,gpt6 --hint-baremetal=ahci0,gpt6 427b86fb-cc66-46be-ad68-ade86794af55
which shows some "--hint" parameters. What do they all mean ?
Quoted 13 lines
Quoted 5 lines
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.
Both are Ubuntu (or may be Debian) specific.
_______________________________________________
Grub-devel mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/grub-devel
08.11.2015 01:58, Arbiel (gmx) пишет:
Quoted 6 lines
Quoted 6 lines
Quoted 5 lines
undocumented command parameter : --hint (command search), and some other --hint.something which I haven't been able to localise just now.
Quoted 7 lines
Quoted 1 line
Which command?
search.
And I just read in a grub.cfg file, not one of mine the linesearch --no-floppy --fs-uuid --set=root --hint-bios=hd0,gpt6 --hint-efi=hd0,gpt6 --hint-baremetal=ahci0,gpt6 427b86fb-cc66-46be-ad68-ade86794af55
which shows some "--hint" parameters. What do they all mean ?
They are intended to optimize search at boot time. They contain guessed firmware device names. If this name was guessed correctly, it avoids searching across all devices at boot time.
In practice for Linux on i386-pc it does not really work because to reliably guess BIOS HDD number you need EDD and with 32 bit Linux boot protocol EDD information must be provided by bootloader.
This is again something that users should not be normally concerned with - these hints are added automatically by probing code. We could add "see development manual for additional options" if we had development manual ... but yes, description of grub-mkconfig framework and which high-level functions are provided is missing.