[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 1/2] docs: Use @ref instead of @xref
From: |
Glenn Washburn |
Subject: |
[PATCH v2 1/2] docs: Use @ref instead of @xref |
Date: |
Tue, 22 Aug 2023 13:26:28 -0500 |
The @xref command is meant to be used at the beginning of a sentence
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>
Signed-off-by: Glenn Washburn <development@efficientek.com>
---
docs/grub.texi | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/grub.texi b/docs/grub.texi
index 61e9a0e9ebf8..c56d9a0afc3b 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -956,7 +956,7 @@ information.
@subsection Kexec with grub2-emu
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 (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.34.1