Skip to content

docs: Document all GRUB modules

Andrew Hamilton grub-devel 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest1 patch 2 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/1docs: Document all GRUB modulesdocs/grub.texi+2114 -41 reply

Reviews trailers per patch

The patch has a Reviewed-by or Acked-by.

PatchDaniel Kiper
1/1R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

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

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(-)
Signature · 7 lines
2.39.2


_______________________________________________
Grub-devel mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/grub-devel