[libvirt] [PATCH] docs: document nmdm type console
* Add nmdm type device to domain format documnetation
* Add a section about nmdm console usage to the bhyve driver
documentation
---
docs/drvbhyve.html.in | 32 ++++++++++++++++++++++++++++++++
docs/formatdomain.html.in | 29 +++++++++++++++++++++++++++++
2 files changed, 61 insertions(+)
diff --git a/docs/drvbhyve.html.in b/docs/drvbhyve.html.in
index 60eee85..0b0e296 100644
--- a/docs/drvbhyve.html.in
+++ b/docs/drvbhyve.html.in
@@ -79,5 +79,37 @@ in libvirt bhyve driver is yet to be implemented).
</domain>
</pre>
+
+<h2><a name="usage">Guest usage / management</a></h2>
+
+<h3><a name="console">Connecting to a guest
console</a></h3>
+
+<p>
+Guest console connection is supported through the <code>nmdm</code> device.
It could be enabled by adding
+the following to the domain XML (<span class="since">Since
1.2.4</span>):
+</p>
+
+<pre>
+ ...
+ <devices>
+ <serial type="nmdm">
+ <source master="/dev/nmdm0A"
slave="/dev/nmdm0B"/>
+ </serial>
+ </devices>
+ ...</pre>
+
+<p>
+Then <code>virsh console</code> command can be used to connect to the text
console
+of a guest.</p>
+
+<p><b>NB:</b> Some versions of bhyve have a bug that prevents guests
from booting
+until the console is opened by a client. This bug was fixed in FreeBSD
+<a
href="http://svnweb.freebsd.org/changeset/base/262884">r2628...;. If
+an older version is used, one either have to open a console manually with
<code>virsh console</code>
+to let a guest boot or start a guest using:</p>
+
+<pre>start --console domname</pre>
+
+
</body>
</html>
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index e851f85..a937e42 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -4721,6 +4721,35 @@ qemu-kvm -net nic,model=? /dev/null
</devices>
...</pre>
+ <h6><a name="elementsNmdm">Nmdm device</a></h6>
+
+ <p>
+ The nmdm device driver, available on FreeBSD, provides two
+ tty devices connected together by a virual null modem cable.
+ <span class="since">Since 1.2.4</span>
+ </p>
+
+<pre>
+ ...
+ <devices>
+ <serial type="nmdm">
+ <source master="/dev/nmdm0A"
slave="/dev/nmdm0B"/>
+ </serial>
+ </devices>
+ ...</pre>
+
+ <p>
+ The <code>source</code> element has these attributes:
+ </p>
+
+ <dl>
+ <dt><code>master</code></dt>
+ <dd>Master device of the pair, that is passed to the hypervisor.</dd>
+
+ <dt><code>slave</code></dt>
+ <dd>Slave device of the pair, that is passed to the clients for connection
+ to the guest console.</dd>
+ </dl>
<h4><a name="elementsSound">Sound devices</a></h4>
--
1.9.0