From: Sam Leonard <sam.leonard@codethink.co.uk>
Date: Fri, 19 Apr 2024 15:31:33 +0000 (+0100)
Subject: man: vmspawn - clarify behaviour of omitting --linux=/--initrd=
X-Git-Tag: v256-rc1~109^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F32251%2Fhead;p=thirdparty%2Fsystemd.git

man: vmspawn - clarify behaviour of omitting --linux=/--initrd=
---

diff --git a/man/systemd-vmspawn.xml b/man/systemd-vmspawn.xml
index 4cf82454f84..8f196dd3525 100644
--- a/man/systemd-vmspawn.xml
+++ b/man/systemd-vmspawn.xml
@@ -179,9 +179,12 @@
           <term><option>--linux=<replaceable>PATH</replaceable></option></term>
 
           <listitem>
-            <para>Set the linux kernel image to use for direct kernel boot.</para>
-
-            <para>If no kernel was installed into the image then the image will fail to boot.</para>
+            <para>Set the linux kernel image to use for direct kernel boot.
+            If a directory type image is used and <option>--linux=</option> was omitted, vmspawn will search for boot loader entries
+            according to the
+            <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink> assuming
+            XBOOTLDR to be located at /boot and ESP to be /efi respectively.
+            If no kernel was installed into the image then the image will fail to boot.</para>
 
             <xi:include href="version-info.xml" xpointer="v256"/>
           </listitem>
@@ -191,13 +194,13 @@
           <term><option>--initrd=<replaceable>PATH</replaceable></option></term>
 
           <listitem>
-            <para>Set the initrd to use for direct kernel boot.</para>
-
-            <para>If the linux kernel supplied is a UKI then this argument is not required.</para>
-
-            <para>If the option is specified multiple times vmspawn will merge the initrds together.</para>
+            <para>Set the initrd to use for direct kernel boot.
+            If the <option>--linux=</option> supplied is a
+            <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink>
+            Type #2 entry, then this argument is not required.
+            If no initrd was installed into the image then the image will fail to boot.</para>
 
-            <para>If no initrd was installed into the image then the image will fail to boot.</para>
+            <para><option>--initrd=</option> can be specified multiple times and vmspawn will merge them together.</para>
 
             <xi:include href="version-info.xml" xpointer="v256"/>
           </listitem>
@@ -571,6 +574,7 @@ $ ssh root@vsock/$my_vsock_cid -i /run/user/$UID/systemd/vmspawn/machine-*-syste
       <member><citerefentry project='debian'><refentrytitle>mkosi</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
       <member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
       <member><citerefentry><refentrytitle>importctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
+      <member><ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink></member>
     </simplelist></para>
   </refsect1>
 </refentry>