[libvirt] [PATCH 2/7] kvmtool: Add documents

Tue Dec 6 14:47:30 UTC 2011

On Fri, Nov 11, 2011 at 07:57:01PM +0800, Osier Yang wrote:
> The document is rather rough now, but at least contains an domain
> config example of all the current supported XMLs, and tells how to
> play with the driver.
> ---
>  docs/drivers.html.in    |    1 +
>  docs/drvkvmtool.html.in |   87 +++++++++++++++++++++++++++++++++++++++++++++++
>  docs/index.html.in      |    3 ++
>  docs/sitemap.html.in    |    4 ++
>  src/README              |    3 +-
>  5 files changed, 97 insertions(+), 1 deletions(-)
>  create mode 100644 docs/drvkvmtool.html.in
> 
> diff --git a/docs/drivers.html.in b/docs/drivers.html.in
> index 75038fc..249c137 100644
> --- a/docs/drivers.html.in
> +++ b/docs/drivers.html.in
> @@ -29,6 +29,7 @@
>        <li><strong><a href="drvvmware.html">VMware Workstation/Player</a></strong></li>
>        <li><strong><a href="drvxen.html">Xen</a></strong></li>
>        <li><strong><a href="drvhyperv.html">Microsoft Hyper-V</a></strong></li>
> +      <li><strong><a href="drvkvmtool.html">Native Linux KVM Tool</a></strong></li>
>      </ul>
>  
>      <h2><a name="stroage">Storage drivers</a></h2>
> diff --git a/docs/drvkvmtool.html.in b/docs/drvkvmtool.html.in
> new file mode 100644
> index 0000000..1b6acdf
> --- /dev/null
> +++ b/docs/drvkvmtool.html.in
> @@ -0,0 +1,87 @@
> +<html>
> +  <body>
> +    <h1>KVM tool driver</h1>
> +
> +    <ul id="toc"></ul>
> +
> +    <p>
> +      The libvirt KVMTOOL driver manages hypervisor Native Linux KVM Tool,
> +      it's implemented by using command line of kvm tool binary.
> +    </p>
> +
> +    <h2><a name="project">Project Links</a></h2>
> +
> +    <ul>
> +      <li>
> +        The <a href="git://github.com/penberg/linux-kvm.git">Native Linux KVM Tool</a> Native
> +        Linux KVM Tool
> +      </li>
> +    </ul>
> +
> +    <h2><a name="uris">Connections to the KVMTOOL driver</a></h2>
> +    <p>
> +      The libvirt KVMTOOL driver is a multi-instance driver, providing a single
> +      system wide privileged driver (the "system" instance), and per-user
> +      unprivileged drivers (the "session" instance). The URI driver protocol
> +      is "kvmtool". Some example conection URIs for the libvirt driver are:
> +    </p>
> +
> +    <pre>
> +      kvmtool:///session                      (local access to per-user instance)
> +      kvmtool+unix:///session                 (local access to per-user instance)
> +
> +      kvmtool:///system                       (local access to system instance)
> +      kvmtool+unix:///system                  (local access to system instance)
> +    </pre>
> +    <p>
> +      cgroups controllers "cpuacct", and "memory" are supported currently.
> +    </p>
> +
> +  <h3>Example config</h3>
> +
> +  <pre>
> +<domain type='kvmtool' id='1'>

As mentioned in a later patch, we should just use  type='kvm' here still


Daniel
-- 
|: http://berrange.com      -o-    http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org              -o-             http://virt-manager.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: http://entangle-photo.org       -o-       http://live.gnome.org/gtk-vnc :|