[PATCH V2 6/6] docs: add description for vgamem attribute and secondary-vga

[Wang Rui <moon.wangrui@xxxxxxxxxx>]

From: Zeng Junliang <zengjunliang@xxxxxxxxxx>

Enhance schema.
Add description for vgamem attribute and secondary-vga.

Signed-off-by: Zeng Junliang <zengjunliang@xxxxxxxxxx>
Signed-off-by: Wang Rui <moon.wangrui@xxxxxxxxxx>
---
 docs/formatdomain.html.in     | 39 ++++++++++++++++++++++++++-------------
 docs/schemas/domaincommon.rng |  5 +++++
 2 files changed, 31 insertions(+), 13 deletions(-)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index b69da4c..98dca4c 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -4272,7 +4272,7 @@ qemu-kvm -net nic,model=? /dev/null
   ...
   &lt;devices&gt;
     &lt;video&gt;
-      &lt;model type='vga' vram='8192' heads='1'&gt;
+      &lt;model type='vga' vgamem='16384' heads='1'&gt;
         &lt;acceleration accel3d='yes' accel2d='yes'/&gt;
       &lt;/model&gt;
     &lt;/video&gt;
@@ -4287,28 +4287,41 @@ qemu-kvm -net nic,model=? /dev/null
         is set but there is a <code>graphics</code> in domain xml, then libvirt
         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
-        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
-        video device. The non-primary must be type of "qxl". The optional
+        <code>type</code> with value "cirrus",  <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 video device. The
+        non-primary must be type of "qxl" or "secondary". The optional
         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>
       <dd>
         The <code>model</code> element has a mandatory <code>type</code>
         attribute which takes the value "vga", "cirrus", "vmvga", "xen",
-        "vbox", or "qxl" (<span class="since">since 0.8.6</span>)
+        "vbox", "qxl" (<span class="since">since 0.8.6</span>), or
+	"secondary" (<span class="since">since 1.2.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). It is invalid for type of
+	"cirrus" or "vga".
+        </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 only valid for type of "vga", "vmvga", "qxl",
+        and "secondary".
+        </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 7be028d..cb272ca 100644
--- a/docs/schemas/domaincommon.rng
+++ b/docs/schemas/domaincommon.rng
@@ -2708,6 +2708,11 @@
             </attribute>
           </optional>
           <optional>
+            <attribute name="vgamem">
+              <ref name="unsignedInt"/>
+            </attribute>
+          </optional>
+          <optional>
             <attribute name="heads">
               <ref name="unsignedInt"/>
             </attribute>
-- 
1.7.12.4


--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list