doc: Make “Automatic LUKS Master Key Passing” an actual section.

This is a followup to b90597b98d, which added
“Automatic LUKS Master Key Passing” in the documentation of the
‘device-tree-support?’ field.

* doc/guix.texi (Bootloader Configuration): Move “Automatic LUKS Master Key
Passing” as an actual subsection below the ‘bootloader-configuration’ doc.
Add an anchor and index entries.  Add @unnumberedsubsec for “Additional Boot
Entries” and for “Themes” together with index entries

Change-Id: I9e43d27b7294144288eb2a8ce1d7903da6dfae45
Signed-off-by: Ludovic Courtès <ludo@gnu.org>
Merges: #8162
This commit is contained in:
Ludovic Courtès
2026-04-26 10:35:26 +02:00
parent 78053b9004
commit 0e18caf221

View File

@@ -19216,7 +19216,7 @@ Partitioning}, for an example.
When using GRUB as the bootloader, the LUKS password is only requested When using GRUB as the bootloader, the LUKS password is only requested
once: GRUB passes the master key to the initial RAM disk automatically. once: GRUB passes the master key to the initial RAM disk automatically.
@xref{Bootloader Configuration, Automatic LUKS Master Key Passing}, for @xref{grub-luks-root-device-key, Automatic LUKS Master Key Passing}, for
details. details.
@end defvar @end defvar
@@ -48960,8 +48960,28 @@ This option in enabled by default. In some cases involving the
in RAM, it can be handy to disable the option by setting it to in RAM, it can be handy to disable the option by setting it to
@code{#f}. @code{#f}.
@subsubheading Automatic LUKS Master Key Passing @item @code{extra-initrd} (default: @code{#f})
File name of an additional initrd to load during the boot. It may or
may not point to a file in the store, but the main use case is for
out-of-store files containing secrets.
For any use case not involving secrets, you should use regular initrd
(@pxref{operating-system Reference, @code{initrd}}) instead.
Be careful when using this option, since pointing to a file that is not
readable by the grub while booting will cause the boot to fail and
require a manual edit of the initrd line in the grub menu.
Currently only supported by GRUB.
@end table
@end deftp
@anchor{grub-luks-root-device-key}
@unnumberedsubsec Automatic LUKS Master Key Passing
@cindex LUKS, root file system encryption
@cindex passphrase, for LUKS-encrypted root
When booting from a LUKS-encrypted device using GRUB, the password is When booting from a LUKS-encrypted device using GRUB, the password is
normally requested twice: once by GRUB to access @file{/boot}, and a normally requested twice: once by GRUB to access @file{/boot}, and a
second time by the initial RAM disk to mount the root file system. second time by the initial RAM disk to mount the root file system.
@@ -49002,22 +49022,7 @@ No configuration is required: GRUB's @code{procfs} and @code{luks}
modules are loaded automatically when encrypted devices are declared modules are loaded automatically when encrypted devices are declared
via @code{luks-device-mapping} (@pxref{Mapped Devices}). via @code{luks-device-mapping} (@pxref{Mapped Devices}).
@item @code{extra-initrd} (default: @code{#f}) @unnumberedsubsec Additional Boot Entries
File name of an additional initrd to load during the boot. It may or
may not point to a file in the store, but the main use case is for
out-of-store files containing secrets.
For any use case not involving secrets, you should use regular initrd
(@pxref{operating-system Reference, @code{initrd}}) instead.
Be careful when using this option, since pointing to a file that is not
readable by the grub while booting will cause the boot to fail and
require a manual edit of the initrd line in the grub menu.
Currently only supported by GRUB.
@end table
@end deftp
@cindex dual boot @cindex dual boot
@cindex boot menu @cindex boot menu
@@ -49146,9 +49151,13 @@ example of chainloading a different GNU/Linux system.
@end table @end table
@end deftp @end deftp
@unnumberedsubsec Themes
@cindex HDPI @cindex HDPI
@cindex HiDPI @cindex HiDPI
@cindex resolution @cindex resolution
@cindex themes, for GRUB
@cindex bootloader themes
@c FIXME: Write documentation once it's stable. @c FIXME: Write documentation once it's stable.
For now only GRUB has theme support. GRUB themes are created using For now only GRUB has theme support. GRUB themes are created using
the @code{grub-theme} form, which is not fully documented yet. the @code{grub-theme} form, which is not fully documented yet.
@@ -49168,7 +49177,7 @@ Return the default GRUB theme used by the operating system if no
@code{theme} field is specified in @code{bootloader-configuration} @code{theme} field is specified in @code{bootloader-configuration}
record. record.
It comes with a fancy background image displaying the GNU and Guix It comes with a fancy background image displaying the Guix
logos. logos.
@end deffn @end deffn