[PATCH 2/2] docs: formatdomain: Mention that vhostuser interface with mode='server' waits for connection

When starting a VM with a vhost-user interface in server mode qemu will wait for the incoming connection without running CPUs. This isn't really documented in our XML. Additionally when hotplugging the same interface the above will not happen. Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- docs/formatdomain.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 4a5241e610..8ab6b7282d 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -6346,6 +6346,11 @@ two attributes ``enabled`` (which accepts ``yes`` and ``no``) and ``timeout`` which specifies the amount of seconds after which hypervisor tries to reconnect. +Note that when ``mode='server'`` is used, the hypervisor will wait for the +incomming connection to be established prior to actually running the VM. This is +not possible when hotplugging an interface the same config so the VM will +continue to run even when no connection is made. It's advised to use +``mode='client'`` instead. vhost-user connection with passt backend ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- 2.48.1