man: vmspawn - clarify behaviour of omitting --vsock-cid=
authorSam Leonard <sam.leonard@codethink.co.uk>
Fri, 19 Apr 2024 15:30:56 +0000 (16:30 +0100)
committerSam Leonard <sam.leonard@codethink.co.uk>
Fri, 19 Apr 2024 15:56:13 +0000 (16:56 +0100)
man/systemd-vmspawn.xml

index ae6a38d49ef2105a95260100a5bb0406af4346dc..4cf82454f849c0d7a86bb8bf2bd1011f8e1a935b 100644 (file)
           <term><option>--vsock-cid=<replaceable>CID</replaceable></option></term>
 
           <listitem>
-            <para>Configure vmspawn to use a specific CID for the guest.</para>
-
-            <para>If the option is not specified or an empty argument is supplied the guest will be assigned a random CID.</para>
-
-            <para>Valid CIDs are in the range <constant>3</constant> to <constant>4294967294</constant> (<constant>0xFFFF_FFFE</constant>).
-            CIDs outside of this range are reserved.</para>
+            <para>Sets the specific CID to use for the guest.
+            Valid CIDs are in the range <constant>3</constant> to <constant>4294967294</constant> (<constant>0xFFFF_FFFE</constant>).
+            CIDs outside of this range are reserved. By default vmspawn will attempt to derive a CID for the guest derived from the machine name,
+            falling back to a random CID if this CID is taken.</para>
 
             <xi:include href="version-info.xml" xpointer="v255"/>
           </listitem>