add more documentation to some actions and configurations

This commit is contained in:
2025-10-19 21:44:05 -07:00
parent 354b5ec130
commit 08da6dd390
7 changed files with 102 additions and 0 deletions

View File

@@ -8,8 +8,14 @@ use std::rc::Rc;
use uefi::boot::SearchType;
use uefi::proto::device_path::LoadedImageDevicePath;
/// Declares a driver configuration.
/// Drivers allow extending the functionality of Sprout.
/// Drivers are loaded at runtime and can provide extra functionality like filesystem support.
/// Drivers are loaded by their name, which is used to reference them in other concepts.
#[derive(Serialize, Deserialize, Default, Clone)]
pub struct DriverDeclaration {
/// The filesystem path to the driver.
/// This file should be an EFI executable that can be located and executed.
pub path: String,
}