* [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
* [PATCH v2 1/2] docs: Use @ref instead of @xref
2023-08-22 18:26 [PATCH v2 0/2] Fix documentation issues reported by Olaf Glenn Washburn
@ 2023-08-22 18:26 ` Glenn Washburn
2023-08-22 18:26 ` [PATCH v2 2/2] docs: Add menu to prevent older makeinfo versions from failing Glenn Washburn
` (2 subsequent siblings)
3 siblings, 0 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
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
_______________________________________________
Grub-devel mailing list
Grub-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/grub-devel
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [PATCH v2 2/2] docs: Add menu to prevent older makeinfo versions from failing
2023-08-22 18:26 [PATCH v2 0/2] Fix documentation issues reported by Olaf Glenn Washburn
2023-08-22 18:26 ` [PATCH v2 1/2] docs: Use @ref instead of @xref Glenn Washburn
@ 2023-08-22 18:26 ` Glenn Washburn
2023-08-23 6:00 ` [PATCH v2 0/2] Fix documentation issues reported by Olaf Oskari Pirhonen
2023-08-24 9:02 ` Olaf Hering
3 siblings, 0 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
It has been reported that makeinfo version 4.13a complains and returns
error when menus for chapter structuring commands are not present. It
is also known that newer makeinfos, such as version 6.7, will create
default menus when needed. Since the menu will be created regardless,
explicitly create it to support older makeinfo versions. This also
enables building to be successful when an older makeinfo is installed
because in that case info files are attempted to be generated with the
"all" target.
Reported-by: Olaf Hering <olaf@aepfle.de>
Signed-off-by: Glenn Washburn <development@efficientek.com>
---
docs/grub-dev.texi | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/docs/grub-dev.texi b/docs/grub-dev.texi
index a695b02f06df..1276c59302af 100644
--- a/docs/grub-dev.texi
+++ b/docs/grub-dev.texi
@@ -788,6 +788,11 @@ out of its way to avoid using hardware breakpoints internally and uses them as
briefly as possible when needed, thus allowing the user to have a maximal
number at their disposal.
+@menu
+* OVMF debug log::
+* Using the gdbinfo command::
+@end menu
+
@node OVMF debug log
@subsection OVMF debug log
--
2.34.1
_______________________________________________
Grub-devel mailing list
Grub-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/grub-devel
^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [PATCH v2 0/2] Fix documentation issues reported by Olaf
2023-08-22 18:26 [PATCH v2 0/2] Fix documentation issues reported by Olaf Glenn Washburn
2023-08-22 18:26 ` [PATCH v2 1/2] docs: Use @ref instead of @xref Glenn Washburn
2023-08-22 18:26 ` [PATCH v2 2/2] docs: Add menu to prevent older makeinfo versions from failing Glenn Washburn
@ 2023-08-23 6:00 ` Oskari Pirhonen
2023-08-24 9:02 ` Olaf Hering
3 siblings, 0 replies; 8+ messages in thread
From: Oskari Pirhonen @ 2023-08-23 6:00 UTC (permalink / raw)
To: Glenn Washburn; +Cc: grub-devel, Daniel Kiper, Olaf Hering
[-- Attachment #1.1: Type: text/plain, Size: 463 bytes --]
On Tue, Aug 22, 2023 at 13:26:27 -0500, Glenn Washburn wrote:
> 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
>
Both patches LGTM at least.
Reviewed-by: Oskari Pirhonen <xxc3ncoredxx@gmail.com>
- Oskari
[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
[-- Attachment #2: Type: text/plain, Size: 141 bytes --]
_______________________________________________
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
* Re: [PATCH v2 0/2] Fix documentation issues reported by Olaf
2023-08-22 18:26 [PATCH v2 0/2] Fix documentation issues reported by Olaf Glenn Washburn
` (2 preceding siblings ...)
2023-08-23 6:00 ` [PATCH v2 0/2] Fix documentation issues reported by Olaf Oskari Pirhonen
@ 2023-08-24 9:02 ` Olaf Hering
2023-08-29 14:43 ` Daniel Kiper
3 siblings, 1 reply; 8+ messages in thread
From: Olaf Hering @ 2023-08-24 9:02 UTC (permalink / raw)
To: Glenn Washburn; +Cc: grub-devel, Daniel Kiper, Oskari Pirhonen
[-- Attachment #1.1: Type: text/plain, Size: 229 bytes --]
Tue, 22 Aug 2023 13:26:27 -0500 Glenn Washburn <development@efficientek.com>:
> Olaf, would you see if this updated patch series fixes your issues?
Yes, this fixes building the documentation in SLE12SP5. Thanks.
Olaf
[-- Attachment #1.2: Digitale Signatur von OpenPGP --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
[-- Attachment #2: Type: text/plain, Size: 141 bytes --]
_______________________________________________
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
* Re: [PATCH v2 0/2] Fix documentation issues reported by Olaf
2023-08-24 9:02 ` Olaf Hering
@ 2023-08-29 14:43 ` Daniel Kiper
2023-08-29 19:41 ` Olaf Hering
0 siblings, 1 reply; 8+ messages in thread
From: Daniel Kiper @ 2023-08-29 14:43 UTC (permalink / raw)
To: Olaf Hering; +Cc: Glenn Washburn, grub-devel, Oskari Pirhonen
On Thu, Aug 24, 2023 at 11:02:49AM +0200, Olaf Hering wrote:
> Tue, 22 Aug 2023 13:26:27 -0500 Glenn Washburn <development@efficientek.com>:
>
> > Olaf, would you see if this updated patch series fixes your issues?
>
> Yes, this fixes building the documentation in SLE12SP5. Thanks.
Reviewed-by: Daniel Kiper <daniel.kiper@oracle.com>
Olaf, may I add "Tested-by" on your behalf?
Daniel
_______________________________________________
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
* Re: [PATCH v2 0/2] Fix documentation issues reported by Olaf
2023-08-29 14:43 ` Daniel Kiper
@ 2023-08-29 19:41 ` Olaf Hering
2023-08-30 14:31 ` Daniel Kiper
0 siblings, 1 reply; 8+ messages in thread
From: Olaf Hering @ 2023-08-29 19:41 UTC (permalink / raw)
To: Daniel Kiper; +Cc: Glenn Washburn, grub-devel, Oskari Pirhonen
[-- Attachment #1.1: Type: text/plain, Size: 150 bytes --]
Tue, 29 Aug 2023 16:43:39 +0200 Daniel Kiper <dkiper@net-space.pl>:
> Olaf, may I add "Tested-by" on your behalf?
Yes, please. Thanks.
Olaf
[-- Attachment #1.2: Digitale Signatur von OpenPGP --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
[-- Attachment #2: Type: text/plain, Size: 141 bytes --]
_______________________________________________
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
* Re: [PATCH v2 0/2] Fix documentation issues reported by Olaf
2023-08-29 19:41 ` Olaf Hering
@ 2023-08-30 14:31 ` Daniel Kiper
0 siblings, 0 replies; 8+ messages in thread
From: Daniel Kiper @ 2023-08-30 14:31 UTC (permalink / raw)
To: Olaf Hering; +Cc: Glenn Washburn, grub-devel, Oskari Pirhonen
On Tue, Aug 29, 2023 at 09:41:59PM +0200, Olaf Hering wrote:
> Tue, 29 Aug 2023 16:43:39 +0200 Daniel Kiper <dkiper@net-space.pl>:
>
> > Olaf, may I add "Tested-by" on your behalf?
>
> Yes, please. Thanks.
Cool! Thanks!
Daniel
_______________________________________________
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
end of thread, other threads:[~2023-08-30 14:32 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-08-22 18:26 [PATCH v2 0/2] Fix documentation issues reported by Olaf Glenn Washburn
2023-08-22 18:26 ` [PATCH v2 1/2] docs: Use @ref instead of @xref Glenn Washburn
2023-08-22 18:26 ` [PATCH v2 2/2] docs: Add menu to prevent older makeinfo versions from failing Glenn Washburn
2023-08-23 6:00 ` [PATCH v2 0/2] Fix documentation issues reported by Olaf Oskari Pirhonen
2023-08-24 9:02 ` Olaf Hering
2023-08-29 14:43 ` Daniel Kiper
2023-08-29 19:41 ` Olaf Hering
2023-08-30 14:31 ` Daniel Kiper
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.