[libvirt] [PATCH RFC 3/3] docs: add description for vgamem attribute
Enhance schema and add description for vgamem attribute.
Signed-off-by: Zeng Junliang <zengjunliang(a)huawei.com>
Signed-off-by: Wang Rui <moon.wangrui(a)huawei.com>
---
docs/formatdomain.html.in | 24 ++++++++++++++++++------
docs/schemas/domaincommon.rng | 5 +++++
2 files changed, 23 insertions(+), 6 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 1b6ced8..72796ec 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -4263,7 +4263,8 @@ qemu-kvm -net nic,model=? /dev/null
will add a default <code>video</code> according to the guest type.
For a guest of type "kvm", the default <code>video</code>
for it is:
<code>type</code> with value "cirrus",
<code>vram</code> with value
- "9216", and <code>heads</code> with value "1". By
default, the first
+ "9216", <code>vgamem</code> (<span
class="since">since 1.2.6</span>) with
+ value "16384", and <code>heads</code> with value
"1". By default, the first
video device in domain xml is the primary one, but the optional
attribute <code>primary</code> (<span
class="since">since 1.0.2</span>)
with value 'yes' can be used to mark the primary in cases of multiple
@@ -4271,8 +4272,8 @@ qemu-kvm -net nic,model=? /dev/null
attribute <code>ram</code> (<span
class="since">since
1.0.2</span>) is allowed for "qxl" type only and specifies
the size of the primary bar, while <code>vram</code> specifies the
- secondary bar size. If "ram" or "vram" are not supplied a
default
- value is used.
+ secondary bar size. If "ram", "vram" or "vgamem"
are not supplied
+ a default value is used.
</dd>
<dt><code>model</code></dt>
@@ -4281,9 +4282,20 @@ qemu-kvm -net nic,model=? /dev/null
attribute which takes the value "vga", "cirrus",
"vmvga", "xen",
"vbox", or "qxl" (<span class="since">since
0.8.6</span>)
depending on the hypervisor features available.
- You can also provide the amount of video memory in kibibytes
- (blocks of 1024 bytes) using
- <code>vram</code> and the number of screen with
<code>heads</code>.
+ <p>
+ <code>vram</code> attribute specifies the amount of video memory
+ in kibibytes (blocks of 1024 bytes). For a guest type of "kvm",
+ it is only valid when type is "qxl".
+ </p>
+ <p>
+ <code>vgamem</code> attribute <span
class="since">since 1.2.6,
+ QEMU and KVM only</span> specifies the size of the framebuffer
+ portion of the "ram" region.
+ And it is not valid when type is "xen" and "vbox".
+ </p>
+ <p>
+ <code>heads</code> attribute specifies the number of screen.
+ </p>
</dd>
<dt><code>acceleration</code></dt>
diff --git a/docs/schemas/domaincommon.rng b/docs/schemas/domaincommon.rng
index 6cc922c..a3f2e60 100644
--- a/docs/schemas/domaincommon.rng
+++ b/docs/schemas/domaincommon.rng
@@ -2698,6 +2698,11 @@
</attribute>
</optional>
<optional>
+ <attribute name="vgamem">
+ <ref name="unsignedInt"/>
+ </attribute>
+ </optional>
+ <optional>
<attribute name="heads">
<ref name="unsignedInt"/>
</attribute>
--
1.7.12.4