Document the new VNC's 'wait' attribute in:
- drvbhyve.rst
- formatdomain.rst
- NEWS.rst
Signed-off-by: Roman Bogorodskiy <bogorodskiy@gmail.com>
---
NEWS.rst | 5 +++++
docs/drvbhyve.rst | 10 ++++++++++
docs/formatdomain.rst | 4 ++++
3 files changed, 19 insertions(+)
diff --git a/NEWS.rst b/NEWS.rst
index 3c3a88ba5b..e2d382d5f8 100644
--- a/NEWS.rst
+++ b/NEWS.rst
@@ -19,6 +19,11 @@ v11.10.0 (unreleased)
* **Improvements**
+ * bhyve: VNC ``wait`` attribute support
+
+ Bhyve guests can now be configured to wait for a VNC connection before
+ booting.
+
* **Bug fixes**
diff --git a/docs/drvbhyve.rst b/docs/drvbhyve.rst
index 73372ff7cf..c0f4cd8a1f 100644
--- a/docs/drvbhyve.rst
+++ b/docs/drvbhyve.rst
@@ -429,6 +429,16 @@ Note: VNC password authentication is known to be cryptographically weak.
Additionally, the password is passed as a command line argument in clear text.
Make sure you understand the risks associated with this feature before using it.
+:since:`Since 11.10.0`, the guest can be configured to wait for an incoming
+VNC connection before booting:
+
+::
+
+ <graphics type='vnc' port='5904' wait='yes'>
+ <listen type='address' address='127.0.0.1'/>
+ </graphics>
+
+
Clock configuration
~~~~~~~~~~~~~~~~~~~
diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index c6d0b183d0..3d3a6b5a6e 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -6902,6 +6902,10 @@ interaction with the admin.
ID is specified, then the default audio backend will be used.
:since:`Since 7.2.0, qemu`.
+ The optional ``wait`` attribute, when set to ``yes``, causes the guest
+ to wait for an incoming VNC connection before booting.
+ :since:`Since 11.10.0, bhyve`.
+
``spice`` :since:`Since 0.8.6`
Starts a SPICE server. The ``port`` attribute specifies the TCP port
number (with -1 as legacy syntax indicating that it should be
--
2.51.2