From fdc5f0e1d2675aaf7d9b5e800a3c729985c38ba6 Mon Sep 17 00:00:00 2001 From: Alex Zenla Date: Mon, 27 Oct 2025 03:52:39 -0400 Subject: [PATCH] chore(docs): mention autoconfiguration support for bls and use it in the docs --- README.md | 29 ++++++++--------------------- docs/fedora-setup.md | 26 +++++--------------------- 2 files changed, 13 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 8aa79a7..254eba5 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,7 @@ The boot menu mechanism is very rudimentary. - [x] Windows boot support via chainload - [x] Load Linux initrd from disk - [x] Basic boot menu +- [x] BLS autoconfiguration support ### Roadmap @@ -100,6 +101,8 @@ Sprout supports some command line options that can be combined to modify behavio $ sprout.efi --config=\path\to\config.toml # Boot a specific entry, bypassing the menu. $ sprout.efi --boot="Boot Xen" +# Autoconfigure Sprout, without loading a configuration file. +$ sprout.efi --autoconfigure ``` ### Boot Linux from ESP @@ -134,27 +137,11 @@ version = 1 [drivers.ext4] path = "\\sprout\\drivers\\ext4.efi" -# extract the full path of the first filesystem -# that contains \loader as a directory -# into the value called "boot" -[extractors.boot.filesystem-device-match] -has-item = "\\loader" - -# use the sprout bls module to scan a bls -# directory for entries and load them as boot -# entries in sprout, using the entry template -# as specified here. the bls action below will -# be passed the extracted values from bls. -[generators.boot.bls] -path = "$boot\\loader" -entry.title = "$title" -entry.actions = ["bls"] - -# the action that is used for each bls entry above. -[actions.bls] -chainload.path = "$boot\\$chainload" -chainload.options = ["$options"] -chainload.linux-initrd = "$boot\\$initrd" +# global options. +[defaults] +# enable autoconfiguration by detecting bls enabled +# filesystems and generating boot entries for them. +autoconfigure = true ``` [Edera]: https://edera.dev diff --git a/docs/fedora-setup.md b/docs/fedora-setup.md index 743ad0a..c712d0d 100644 --- a/docs/fedora-setup.md +++ b/docs/fedora-setup.md @@ -39,27 +39,11 @@ version = 1 [drivers.ext4] path = "\\sprout\\drivers\\ext4.efi" -# extract the full path of the first filesystem -# that contains \loader as a directory -# into the value called "boot" -[extractors.boot.filesystem-device-match] -has-item = "\\loader" - -# use the sprout bls module to scan a bls -# directory for entries and load them as boot -# entries in sprout, using the entry template -# as specified here. the bls action below will -# be passed the extracted values from bls. -[generators.boot.bls] -path = "$boot\\loader" -entry.title = "$title" -entry.actions = ["bls"] - -# the action that is used for each bls entry above. -[actions.bls] -chainload.path = "$boot\\$chainload" -chainload.options = ["$options"] -chainload.linux-initrd = "$boot\\$initrd" +# global options. +[defaults] +# enable autoconfiguration by detecting bls enabled +# filesystems and generating boot entries for them. +autoconfigure = true ``` ## Step 3, Option 1: Configure GRUB to load Sprout (recommended)