[libvirt] [PATCH 2/3] docs: bhyve: document commandline element

[Daniel P. Berrangé]

On Fri, Jan 18, 2019 at 07:41:01PM +0400, Roman Bogorodskiy wrote:
> Document the <bhyve:commandline> element which allows
> to inject custom command line arguments for bhyve.
> 
> Signed-off-by: Roman Bogorodskiy <bogorodskiy at gmail.com>
> ---
>  docs/drvbhyve.html.in | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
> 
> diff --git a/docs/drvbhyve.html.in b/docs/drvbhyve.html.in
> index b4d7df2edb..d3c1585e33 100644
> --- a/docs/drvbhyve.html.in
> +++ b/docs/drvbhyve.html.in
> @@ -460,6 +460,26 @@ Example:</p>
>      </cpu>
>      ...
>  </domain>
> +</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><bhyve:commandline></code> element under <code>domain</code>.
> +This element could 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>.


Can you expand this text to mention that when using this feature there
is zero guarantee that the usage will work the same way in future libvirt
releases. It is something that is valid to use for experimenting with
features prior to implementing official support in libvirt, but should
not be used in production deployments.

> +</p>
> +<p>Example:</p>
> +<pre>
> +<domain type="bhyve" xmlns:bhyve="http://libvirt.org/schemas/domain/bhyve/1.0">
> +  ...
> +  <bhyve:commandline>
> +    <bhyve:arg value='-somebhyvearg'/>
> +  </bhyve:commandline>
> +</domain>
>  </pre>
>  
>    </body>
> -- 
> 2.20.1
> 
> --
> libvir-list mailing list
> libvir-list at redhat.com
> https://www.redhat.com/mailman/listinfo/libvir-list

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|