[libvirt] [PATCH] docs: Document bhyve's vgaconf support

Roman Bogorodskiy bogorodskiy at gmail.com
Thu Jun 29 06:53:29 UTC 2017

 - Add a news entry
 - Update driver's page with information about the new
   vgaconf attribute and provide usage example; while here,
   fix a grammar mistake

Signed-off-by: Roman Bogorodskiy <bogorodskiy at gmail.com>
 docs/drvbhyve.html.in | 28 +++++++++++++++++++++++++++-
 docs/news.xml         | 12 ++++++++++++
 2 files changed, 39 insertions(+), 1 deletion(-)

diff --git a/docs/drvbhyve.html.in b/docs/drvbhyve.html.in
index dd6620d..f083db9 100644
--- a/docs/drvbhyve.html.in
+++ b/docs/drvbhyve.html.in
@@ -351,10 +351,36 @@ FreeBSD port.</p>
 <p>This way, VNC will be accessible on <code></code>.</p>
-<p>Please note that the tablet device requires to have an USB controller
+<p>Please note that the tablet device requires to have a USB controller
 of the <code>nec-xhci</code> model. Currently, only a single controller of this
 type and a single tablet are supported per domain.</p>
+<p><span class="since">Since 3.5.0</span>, it's possible to configure how the video device is exposed
+to the guest using the <code>vgaconf</code> attribute:</p>
+<domain type='bhyve'>
+    <devices>
+    ...
+      <graphics type='vnc' port='5904'>
+        <listen type='address' address=''/>
+      </graphics>
+      <video>
+        <driver vgaconf='on'/>
+        <model type='gop' heads='1' primary='yes'/>
+      </video>
+      ...
+    </devices>
+    ...
+<p>If not specified, bhyve's default mode for <code>vgaconf</code>
+will be used. Please refer to the
+<a href="https://www.freebsd.org/cgi/man.cgi?query=bhyve&sektion=8&manpath=FreeBSD+12-current">bhyve(8)</a>
+manual page and the <a href="https://wiki.freebsd.org/bhyve">bhyve wiki</a> for more details on using
+the <code>vgaconf</code> option.</p>
 <h3><a name="clockconfig">Clock configuration</a></h3>
 <p>Originally bhyve supported only localtime for RTC. Support for UTC time was introduced in
diff --git a/docs/news.xml b/docs/news.xml
index 27562e1..d320965 100644
--- a/docs/news.xml
+++ b/docs/news.xml
@@ -46,6 +46,18 @@
           select a boot entry.
+      <change>
+        <summary>
+          Support controlling how video devices are exposed to the bhyve guests
+        </summary>
+        <description>
+          The <code>vgaconf</code> attribute was added to <code>video</code>'s
+          <code>driver</code> element. Possible values are: <code>on</code>,
+          <code>off</code>, and <code>io</code>. It controlls the way how
+          bhyve exposes video devices to its guests; various guest OSes might
+          require different settings to boot properly.
+        </description>
+      </change>
     <section title="Improvements">

More information about the libvir-list mailing list