Re: [PATCH v2 2/2] docs: Document efitextmode command

[Daniel Kiper]

On Fri, May 13, 2022 at 12:54:12PM -0500, Glenn Washburn wrote:
> Signed-off-by: Glenn Washburn <development@efficientek.com>

I think this patch should be merged with patch #1.

> ---
>  docs/grub.texi | 26 ++++++++++++++++++++++++++
>  1 file changed, 26 insertions(+)
>
> diff --git a/docs/grub.texi b/docs/grub.texi
> index 5de94d062..178957096 100644
> --- a/docs/grub.texi
> +++ b/docs/grub.texi
> @@ -4049,6 +4049,7 @@ you forget a command, you can run the command 
> @command{help}
>  * distrust::                    Remove a pubkey from trusted keys
>  * drivemap::                    Map a drive to another
>  * echo::                        Display a line of text
> +* efitextmode::                 Set/Get text output mode resolution
>  * eval::                        Evaluate agruments as GRUB commands
>  * export::                      Export an environment variable
>  * false::                       Do nothing, unsuccessfully
> @@ -4505,6 +4506,31 @@ character will print that character.
>  @end deffn
>
>
> +@node efitextmode
> +@subsection efitextmode
> +
> +@deffn Command efitextmode [min | max | mode_num]

s/mode_num/<mode_num>/?

After some thinking it seems to me this interface is not very convenient.
My guess is that the same mode may have different <mode_num> on
different implementations/platforms. I think EFI shell "mode" command
"col" "row" approach is more universal/reliable. Though I think it makes
sense to leave min and max as is...

> +When used with no arguments displays all available text output modes. The
> +set mode determines the columns and rows of the text display when in
> +text mode. An asterisk, @samp{*}, will be at the end of the line of the
> +currently set mode.
> +
> +Otherwise the command only takes a single parameter, which can be
> +@samp{min}, @samp{max}, or a mode number given by the listing when run
> +with no arguments. These arguments set the mode to the minimum, maximum,
> +and particular mode respectively.
> +
> +By default GRUB will start in whatever mode the EFI firmware defaults to.
> +There are firmwares known to set up the default mode such that output
> +behaves strangely, for example the cursor in the grub shell never reaches
> +the bottom of the screen or, when typing characters at the prompt,
> +characters from previous command output are overwritten. Setting the mode
> +may fix this.
> +
> +Note: This command is only available on EFI platforms.

s/./ and is similar to EFI shell "mode" command./?

Daniel