grub-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH 0/1] docs: Document all GRUB modules


From: Federico Vaga
Subject: Re: [PATCH 0/1] docs: Document all GRUB modules
Date: Tue, 27 Aug 2024 14:17:33 +0200

Thank you, Andrew, for this patch. Unfortunately, I can't review the actual
patch because I'm a user with the desire to read more about modules. But
definitively, I've learned something in reading your patch. I find it useful.

On Sun, Aug 04, 2024 at 11:32:50AM -0500, Andrew Hamilton wrote:
Currently the GRUB Manual is missing documentation on most of the modules
available in GRUB. This makes it difficult for users to understand what
features / capabilities exist and to fine-tune which modules their system
includes.

Based on positive feedback received from 2024-06 / 2024-07 mail thread
"Idea / Feedback Request: GRUB Manual - Modules Documentation Improve"
(https://lists.gnu.org/archive/html/grub-devel/2024-07/msg00023.html)
I have proceeded with adding documentation of the GRUB modules. I have
attempted to capture some documentation for all GRUB modules I was able
to see in the current source tree. Whenever possible - I pointed to
detailed documentation on commands (cross reference from the module to
the command documentation) when such documentation was available. I did
my best to interpret the source code to provide a basic high level summary
of the module's purpose.

From user perspective, this patch will greatly expand (I counted a bit
more than 300 modules today) section 16 (Modules) of the GRUB Manual, and
I also added some detail on the "file" command (moved it from
undocumented).


Andrew Hamilton (1):
 docs: Document all GRUB modules

docs/grub.texi | 2118 +++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 2114 insertions(+), 4 deletions(-)

--
2.39.2


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

--
Federico Vaga - CERN BE-CEM-EDL



reply via email to

[Prev in Thread] Current Thread [Next in Thread]