From: Roman Bogorodskiy <bogorodskiy@gmail.com>
Date: Fri, 18 Jan 2019 14:42:02 +0000 (+0400)
Subject: docs: bhyve: document commandline element
X-Git-Tag: v5.1.0-rc1~354
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0ffe70a929728415e1a84e63fa078d252112a224;p=thirdparty%2Flibvirt.git

docs: bhyve: document commandline element

Document the <bhyve:commandline> element which allows
to inject custom command line arguments for bhyve.

Signed-off-by: Roman Bogorodskiy <bogorodskiy@gmail.com>
Reviewed-by: John Ferlan <jferlan@redhat.com>
---

diff --git a/docs/drvbhyve.html.in b/docs/drvbhyve.html.in
index b4d7df2edb..fb73b4819b 100644
--- a/docs/drvbhyve.html.in
+++ b/docs/drvbhyve.html.in
@@ -460,6 +460,28 @@ Example:</p>
     &lt;/cpu&gt;
     ...
 &lt;/domain&gt;
+</pre>
+
+<h3><a id="bhyvecommand">Pass-through of arbitrary bhyve commands</a></h3>
+
+<p><span class="since">Since 5.1.0</span>, it's possible to pass additional command-line
+arguments to the bhyve process when starting the domain using the
+<code>&lt;bhyve:commandline&gt;</code> element under <code>domain</code>.
+To supply an argument, use the element <code>&lt;bhyve:arg&gt;</code> with
+the attribute <code>value</code> set to additional argument to be added.
+The arg element may be repeated multiple times. To use this XML addition, it is necessary
+to issue an XML namespace request (the special <code>xmlns:<i>name</i></code> attribute)
+that pulls in <code>http://libvirt.org/schemas/domain/bhyve/1.0</code>;
+typically, the namespace is given the name of <code>bhyve</code>.
+</p>
+<p>Example:</p>
+<pre>
+&lt;domain type="bhyve" xmlns:bhyve="http://libvirt.org/schemas/domain/bhyve/1.0"&gt;
+  ...
+  &lt;bhyve:commandline&gt;
+    &lt;bhyve:arg value='-somebhyvearg'/&gt;
+  &lt;/bhyve:commandline&gt;
+&lt;/domain&gt;
 </pre>
 
   </body>