From 6bc66052c228d12c65e79db101d48182760310f8 Mon Sep 17 00:00:00 2001
From: Julian Stecklina <js@alien8.de>
Date: Fri, 25 Nov 2022 18:05:44 +0100
Subject: [PATCH] lanzaboote: add EmbeddedConfiguration docs

---
 rust/lanzaboote/src/main.rs | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/rust/lanzaboote/src/main.rs b/rust/lanzaboote/src/main.rs
index 8310fe1..2dac3a8 100644
--- a/rust/lanzaboote/src/main.rs
+++ b/rust/lanzaboote/src/main.rs
@@ -43,8 +43,18 @@ fn print_logo(output: &mut Output) {
         .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 {
+    /// 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,
+
+    /// The filename of the initrd to be passed to the kernel. See
+    /// `kernel_filename` for how to interpret these filenames.
     initrd_filename: CString16,
 }