improve doc comment

oxidecomputer · Oct 1, 2024 · 04fb943 · 04fb943
1 parent 900b5c6
commit 04fb943
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/crates/propolis-api-types/src/instance_spec/components/devices.rs b/crates/propolis-api-types/src/instance_spec/components/devices.rs
@@ -104,8 +104,9 @@ pub struct QemuPvpanic {
     // TODO(eliza): add support for the PCI PVPANIC device...
 }
 
-/// A set of settings that determines what Propolis tells guest firmware about
-/// how to boot a guest operating system.
+/// Settings supplied to the guest's firmware image that specify the order in
+/// which it should consider its options when selecting a device to try to boot
+/// from.
 #[derive(Clone, Deserialize, Serialize, Debug, JsonSchema, Default)]
 #[serde(deny_unknown_fields)]
 pub struct BootSettings {

diff --git a/openapi/propolis-server.json b/openapi/propolis-server.json
@@ -522,7 +522,7 @@
         ]
       },
       "BootSettings": {
-        "description": "A set of settings that determines what Propolis tells guest firmware about how to boot a guest operating system.",
+        "description": "Settings supplied to the guest's firmware image that specify the order in which it should consider its options when selecting a device to try to boot from.",
         "type": "object",
         "properties": {
           "order": {