[PATCH v2 0/2] Fix documentation issues reported by Olaf

* [PATCH v2 0/2] Fix documentation issues reported by Olaf
@ 2023-08-22 18:26 Glenn Washburn
  2023-08-22 18:26 ` [PATCH v2 1/2] docs: Use @ref instead of @xref Glenn Washburn
                   ` (3 more replies)
  0 siblings, 4 replies; 8+ messages in thread
From: Glenn Washburn @ 2023-08-22 18:26 UTC (permalink / raw)
  To: grub-devel, Daniel Kiper, Olaf Hering; +Cc: Oskari Pirhonen, Glenn Washburn

Updates from v1:
 * Use @ref instead of @pxref as suggested by Oskari

Olaf, would you see if this updated patch series fixes your issues?

Glenn

Glenn Washburn (2):
  docs: Use @ref instead of @xref
  docs: Add menu to prevent older makeinfo versions from failing

 docs/grub-dev.texi | 5 +++++
 docs/grub.texi     | 2 +-
 2 files changed, 6 insertions(+), 1 deletion(-)

Range-diff against v1:
1:  d85c7efc5681 ! 1:  9b49f9ab7319 docs: Use @pxref instead of @xref inside parenthesis
    @@ Metadata
     Author: Glenn Washburn <development@efficientek.com>

      ## Commit message ##
    -    docs: Use @pxref instead of @xref inside parenthesis
    +    docs: Use @ref instead of @xref

         The @xref command is meant to be used at the beginning of a sentence
    -    because its expansion creates a "See " prefix. The @pxref expands with
    -    a prefix of "see " and is meant to be used within parenthesis. This also
    -    fixes an issue where there was a repeated "see" in the output.
    +    because its expansion creates a "See " prefix on all output formats, and
    +    on older makeinfo versions is strict about enforcing a '.' or ',' after
    +    the command. The @ref command has no such restriction and is just the
    +    link, which allows more control over output. This also fixes an issue
    +    where there was a repeated "see" in the output.

         Reported-by: Olaf Hering <olaf@aepfle.de>

    @@ docs/grub.texi: 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
    -+read all configuration scripts as if booting directly (@pxref{Loading
    ++read all configuration scripts as if booting directly (see @ref{Loading
      an operating system directly}). With the @code{--kexec} flag, and
      kexec(8) support from the operating system, the @command{linux} command
      will directly boot the target image. For systems that lack working
2:  bb2ddd029460 = 2:  de20b4cddba8 docs: Add menu to prevent older makeinfo versions from failing
-- 
2.34.1

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

^ permalink raw reply	[flat|nested] 8+ messages in thread