docs: Document bhyve's vgaconf support

 - 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@gmail.com>
Reviewed-by: Andrea Bolognani <abologna@redhat.com>

diff --git a/docs/drvbhyve.html.in b/docs/drvbhyve.html.in
index dd6620d59a94e7f843dd02964bddeed01d0fda1c..f083db91c545881cd57f3541439cb841a3032d59 100644 (file)
--- 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>127.0.0.1:5904</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>
+
+<pre>
+&lt;domain type='bhyve'&gt;
+    &lt;devices&gt;
+    ...
+      &lt;graphics type='vnc' port='5904'&gt;
+        &lt;listen type='address' address='127.0.0.1'/&gt;
+      &lt;/graphics&gt;
+      &lt;video&gt;
+        &lt;driver vgaconf='on'/&gt;
+        &lt;model type='gop' heads='1' primary='yes'/&gt;
+      &lt;/video&gt;
+      ...
+    &lt;/devices&gt;
+    ...
+&lt;/domain&gt;
+</pre>
+
+<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&amp;sektion=8&amp;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 f4423a646c8d419e4bee697dd2602f3cdb227d0a..933189484c652fa7934895a5e214fc9576c27e21 100644 (file)
--- a/docs/news.xml
+++ b/docs/news.xml
@@ -46,6 +46,18 @@
           select a boot entry.
         </description>
       </change>
+      <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>
     <section title="Improvements">
       <change>