lanzaboote: add EmbeddedConfiguration docs

This commit is contained in:
Julian Stecklina 2022-11-25 18:05:44 +01:00
parent a9edb1488e
commit 6bc66052c2
1 changed files with 10 additions and 0 deletions

View File

@ -43,8 +43,18 @@ fn print_logo(output: &mut Output) {
.unwrap(); .unwrap();
} }
/// The configuration that is embedded at build time.
///
/// After lanzaboote is built, lanzatool needs to embed configuration
/// into the binary. This struct represents that information.
struct EmbeddedConfiguration { struct EmbeddedConfiguration {
/// The filename of the kernel to be booted. This filename is
/// relative to the root of the volume that contains the
/// lanzaboote binary.
kernel_filename: CString16, kernel_filename: CString16,
/// The filename of the initrd to be passed to the kernel. See
/// `kernel_filename` for how to interpret these filenames.
initrd_filename: CString16, initrd_filename: CString16,
} }