On Wed, 16 Aug 2023 10:41:40 +0200
Olaf Hering <o...@aepfle.de> wrote:

> Wed, 16 Aug 2023 00:29:28 -0500 Glenn Washburn <developm...@efficientek.com>:
> 
> > Anyway, since you're the first and *so far* only person seeing this,
> > could you submit a patch that fixes this for you? It would be great to
> > support older makeinfos (if that is indeed the issue) in the upcoming
> > release.
> 
> The change below fixes the following errors:
> 
> grub.texi:960: warning: `.' or `,' must follow @xref, not `)'.
> grub.texi:960: warning: for cross-references in parentheses, use @pxref.
> grub-dev.texi:815: `Using the gdbinfo command' has no Up field (perhaps 
> incorrect sectioning?).
> grub-dev.texi:791: `OVMF debug log' has no Up field (perhaps incorrect 
> sectioning?).
> grub-dev.texi:815: warning: unreferenced node `Using the gdbinfo command'.
> 
> With some rewording the first error could be fixed properly.

Thanks for working on this. My comments below.

> 
> 
> Olaf
> 
> --- a/docs/grub-dev.texi
> +++ b/docs/grub-dev.texi
> @@ -632,6 +632,8 @@ various targets using @command{gdb} and the 
> @samp{gdb_grub} GDB script.
>  @menu
>  * i386-pc::
>  * x86_64-efi::
> +* OVMF debug log::
> +* Using the gdbinfo command::

I specifically wanted these two sections to be subsections of
x86_64-efi and not at the same level as i386-pc, hence why I have them
as subsections. I suspect that the issue could be fixed by adding a
@menu in the x86_64-efi section with these two lines. I didn't really
want a menu there, but I'm fine with it if it fixes it for you.

>  @end menu
>  
>  @node i386-pc
> @@ -789,7 +791,7 @@ briefly as possible when needed, thus allowing the user 
> to have a maximal
>  number at their disposal.
>  
>  @node OVMF debug log
> -@subsection OVMF debug log
> +@section OVMF debug log
>  
>  In order to get the GRUB2 load address from OVMF, first, a debug build
>  of OVMF must be obtained 
> (@uref{https://github.com/retrage/edk2-nightly/raw/master/bin/DEBUGX64_OVMF.fd,
> @@ -813,7 +815,7 @@ means that the GRUB2 EFI application was loaded at 
> @samp{0x00006AEE000} and
>  its .text section is at @samp{0x00006AEE756}.
>  
>  @node Using the gdbinfo command
> -@subsection Using the gdbinfo command
> +@section Using the gdbinfo command
>  
>  On EFI platforms the command @command{gdbinfo} will output a string that
>  is to be run in a GDB session running with the @file{gdb_grub} GDB script.
> --- a/docs/grub.texi
> +++ b/docs/grub.texi
> @@ -957,7 +957,7 @@ information.
>  
>  GRUB can be run in userspace by invoking the grub2-emu tool. It will
>  read all configuration scripts as if booting directly (see @xref{Loading
> -an operating system directly}). With the @code{--kexec} flag, and
> +an operating system directly}.) With the @code{--kexec} flag, and

Actually I think the correction should be:

  (@pxref{Loading an operating system directly}).

@xref is for use at the beginning of a sentence and @pxref is for
use inside parenthesis[1].

Glenn

[1]
https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Cross-Reference-Commands.html

>  kexec(8) support from the operating system, the @command{linux} command
>  will directly boot the target image. For systems that lack working
>  systemctl(1) support for kexec, passing the @code{--kexec} flag twice

_______________________________________________
Grub-devel mailing list
Grub-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/grub-devel

Reply via email to