[libvirt] [PATCH] Fix and improve domain xml video element description

The description mismatched the actual structure since the video element was introduced. The nvram attribute is actually called vram. Specify the unit of the vram attribute. --- docs/formatdomain.html.in | 30 ++++++++++++++++++++++-------- 1 files changed, 22 insertions(+), 8 deletions(-) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 5b7aa10..3d418b9 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -768,20 +768,34 @@ qemu-kvm -net nic,model=? /dev/null <pre> ... - <video type='vga' nvram='8192' heads='1'> - <acceleration accel3d='yes' accel3d='yes' /> + <video> + <model type='vga' vram='8192' heads='1'> + <acceleration accel3d='yes' accel3d='yes'/> + </model> </video> ...</pre> <dl> <dt><code>video</code></dt> - <dd>The <code>video</code> element has a mandatory <code>type</code> - attribute which takes the value "vga", "cirrus", "vmvga", "xen" or "vbox". - You can also provide the amount of video memory using <code>nvram</code>, - the number of screen with <code>heads</code>, and whether acceleration - should be enabled (if supported) using the <code>accel3d</code> and - <code>accel2d</code> attributes in the <code>acceleration</code> element. + <dd> + The <code>video</code> element is the a container for describing + video devices. + </dd> + + <dt><code>model</code></dt> + <dd> + The <code>model</code> element has a mandatory <code>type</code> + attribute which takes the value "vga", "cirrus", "vmvga", "xen" or "vbox". + You can also provide the amount of video memory in kilobytes using + <code>vram</code> and the number of screen with <code>heads</code>. + </dd> + <dt><code>acceleration</code></dt> + <dd> + If acceleration should be enabled (if supported) using the + <code>accel3d</code> and <code>accel2d</code> attributes in the + <code>acceleration</code> element. + </dd> </dl> <h4><a name="elementsConsole">Consoles, serial, parallel & channel devices</a></h4> -- 1.6.0.4

On Sun, Dec 13, 2009 at 10:15:20PM +0100, Matthias Bolte wrote:
The description mismatched the actual structure since the video element was introduced. The nvram attribute is actually called vram. Specify the unit of the vram attribute. --- docs/formatdomain.html.in | 30 ++++++++++++++++++++++-------- 1 files changed, 22 insertions(+), 8 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 5b7aa10..3d418b9 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -768,20 +768,34 @@ qemu-kvm -net nic,model=? /dev/null
<pre> ... - <video type='vga' nvram='8192' heads='1'> - <acceleration accel3d='yes' accel3d='yes' /> + <video> + <model type='vga' vram='8192' heads='1'> + <acceleration accel3d='yes' accel3d='yes'/> + </model> </video> ...</pre>
<dl> <dt><code>video</code></dt> - <dd>The <code>video</code> element has a mandatory <code>type</code> - attribute which takes the value "vga", "cirrus", "vmvga", "xen" or "vbox". - You can also provide the amount of video memory using <code>nvram</code>, - the number of screen with <code>heads</code>, and whether acceleration - should be enabled (if supported) using the <code>accel3d</code> and - <code>accel2d</code> attributes in the <code>acceleration</code> element. + <dd> + The <code>video</code> element is the a container for describing + video devices. + </dd> + + <dt><code>model</code></dt> + <dd> + The <code>model</code> element has a mandatory <code>type</code> + attribute which takes the value "vga", "cirrus", "vmvga", "xen" or "vbox". + You can also provide the amount of video memory in kilobytes using + <code>vram</code> and the number of screen with <code>heads</code>. + </dd>
+ <dt><code>acceleration</code></dt> + <dd> + If acceleration should be enabled (if supported) using the + <code>accel3d</code> and <code>accel2d</code> attributes in the + <code>acceleration</code> element. + </dd> </dl>
<h4><a name="elementsConsole">Consoles, serial, parallel & channel devices</a></h4>
ACK, thanks for the cleanup ! Daniel -- Daniel Veillard | libxml Gnome XML XSLT toolkit http://xmlsoft.org/ daniel@veillard.com | Rpmfind RPM search engine http://rpmfind.net/ http://veillard.com/ | virtualization library http://libvirt.org/

2009/12/14 Daniel Veillard <veillard@redhat.com>:
On Sun, Dec 13, 2009 at 10:15:20PM +0100, Matthias Bolte wrote:
The description mismatched the actual structure since the video element was introduced. The nvram attribute is actually called vram. Specify the unit of the vram attribute. --- docs/formatdomain.html.in | 30 ++++++++++++++++++++++-------- 1 files changed, 22 insertions(+), 8 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 5b7aa10..3d418b9 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -768,20 +768,34 @@ qemu-kvm -net nic,model=? /dev/null
<pre> ... - <video type='vga' nvram='8192' heads='1'> - <acceleration accel3d='yes' accel3d='yes' /> + <video> + <model type='vga' vram='8192' heads='1'> + <acceleration accel3d='yes' accel3d='yes'/> + </model> </video> ...</pre>
<dl> <dt><code>video</code></dt> - <dd>The <code>video</code> element has a mandatory <code>type</code> - attribute which takes the value "vga", "cirrus", "vmvga", "xen" or "vbox". - You can also provide the amount of video memory using <code>nvram</code>, - the number of screen with <code>heads</code>, and whether acceleration - should be enabled (if supported) using the <code>accel3d</code> and - <code>accel2d</code> attributes in the <code>acceleration</code> element. + <dd> + The <code>video</code> element is the a container for describing + video devices. + </dd> + + <dt><code>model</code></dt> + <dd> + The <code>model</code> element has a mandatory <code>type</code> + attribute which takes the value "vga", "cirrus", "vmvga", "xen" or "vbox". + You can also provide the amount of video memory in kilobytes using + <code>vram</code> and the number of screen with <code>heads</code>. + </dd>
+ <dt><code>acceleration</code></dt> + <dd> + If acceleration should be enabled (if supported) using the + <code>accel3d</code> and <code>accel2d</code> attributes in the + <code>acceleration</code> element. + </dd> </dl>
<h4><a name="elementsConsole">Consoles, serial, parallel & channel devices</a></h4>
ACK, thanks for the cleanup !
Daniel
Okay, pushed. Matthias
participants (2)
-
Daniel Veillard
-
Matthias Bolte