From nobody Sun Feb  8 20:53:38 2026
Delivered-To: importer@patchew.org
Received-SPF: pass (zohomail.com: domain of redhat.com designates
 207.211.31.81 as permitted sender) client-ip=207.211.31.81;
 envelope-from=libvir-list-bounces@redhat.com;
 helo=us-smtp-delivery-1.mimecast.com;
Authentication-Results: mx.zohomail.com;
	dkim=pass;
	spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass(p=none dis=none)  header.from=redhat.com
ARC-Seal: i=1; a=rsa-sha256; t=1595510559; cv=none;
	d=zohomail.com; s=zohoarc;
	b=ks7RA0/kIf9b5zyAqVjkwOdVeqV9JS8QYe85Zf1sERwj/Z7B+qHXPff31/9jiA4hEvI0wFtgvbok19ar31ZXW3+arIdtLgRrRLqQj7JlmB43jBZnRoHN+ct/OwarUYFtbPq6jz+11Y4fDTY76X+rgv9DLpmWf41W1gRE3SbYXMk=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com;
 s=zohoarc;
	t=1595510559;
 h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To;
	bh=lBwQGcynqs6j6OMNfRUp4FR630XNyQAeuRuY/H91cJ4=;
	b=Yz12OhR5Ii4eU6dJdop2aLDICNc1VkYYX+kJY5ZBhNviXINtEBBmXfPOSGYEglMyDvgHjM5VQfHI8rHofnBvSAFChdrzMIBHGSkCiyZkYkfy5SkGNzM5eETsjMxMUHkd1XoaTYriavBngPON3UzMHUvaHtZLj+mTr8/FXzw/15Q=
ARC-Authentication-Results: i=1; mx.zohomail.com;
	dkim=pass;
	spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass header.from=<pkrempa@redhat.com> (p=none dis=none)
 header.from=<pkrempa@redhat.com>
Return-Path: <libvir-list-bounces@redhat.com>
Received: from us-smtp-delivery-1.mimecast.com (us-smtp-1.mimecast.com
 [207.211.31.81]) by mx.zohomail.com
	with SMTPS id 1595510559698233.2032676363791;
 Thu, 23 Jul 2020 06:22:39 -0700 (PDT)
Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com
 [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id
 us-mta-119-EFJRXEEzN1qX2aF_mGOaPQ-1; Thu, 23 Jul 2020 09:22:35 -0400
Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com
 [10.5.11.13])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 500D0803321;
	Thu, 23 Jul 2020 13:22:29 +0000 (UTC)
Received: from colo-mx.corp.redhat.com
 (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20])
	by smtp.corp.redhat.com (Postfix) with ESMTPS id 2E26C8BEE5;
	Thu, 23 Jul 2020 13:22:29 +0000 (UTC)
Received: from lists01.pubmisc.prod.ext.phx2.redhat.com
 (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33])
	by colo-mx.corp.redhat.com (Postfix) with ESMTP id EFE411805313;
	Thu, 23 Jul 2020 13:22:28 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com
	[10.5.11.23])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id 06NDMQj7028659 for <libvir-list@listman.util.phx.redhat.com>;
	Thu, 23 Jul 2020 09:22:26 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id 86DF02DE86; Thu, 23 Jul 2020 13:22:26 +0000 (UTC)
Received: from speedmetal.redhat.com (unknown [10.40.208.37])
	by smtp.corp.redhat.com (Postfix) with ESMTP id D399819D7C
	for <libvir-list@redhat.com>; Thu, 23 Jul 2020 13:22:25 +0000 (UTC)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;
	s=mimecast20190719; t=1595510558;
	h=from:from:sender:sender:reply-to:subject:subject:date:date:
	 message-id:message-id:to:to:cc:mime-version:mime-version:
	 content-type:content-type:
	 content-transfer-encoding:content-transfer-encoding:
	 in-reply-to:in-reply-to:references:references:list-id:list-help:
	 list-unsubscribe:list-subscribe:list-post;
	bh=lBwQGcynqs6j6OMNfRUp4FR630XNyQAeuRuY/H91cJ4=;
	b=aSATojhjsk6mr5JOBZj8UhQgPunfe0my4Vm9pcwJIlcl0ybtqIgucebDT4DApENJH0AiGs
	19WMHfkJvRBkvRXA5YrCrbaqsVrAvQD5AkynzT5UtqPDXp1mkg/kicmX6kjUhvC0+veNDJ
	jiQJmseu7gmNIsW8qBF8vJKhVoLx72g=
X-MC-Unique: EFJRXEEzN1qX2aF_mGOaPQ-1
From: Peter Krempa <pkrempa@redhat.com>
To: libvir-list@redhat.com
Subject: [PATCH 20/32] docs: formatdomain-devices: Split out <videO>
Date: Thu, 23 Jul 2020 15:21:25 +0200
Message-Id: 
 <60055b2e55f152393d9432d803dddbf9ecea6159.1595510131.git.pkrempa@redhat.com>
In-Reply-To: <cover.1595510131.git.pkrempa@redhat.com>
References: <cover.1595510131.git.pkrempa@redhat.com>
MIME-Version: 1.0
X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23
X-loop: libvir-list@redhat.com
X-BeenThere: libvir-list@redhat.com
X-Mailman-Version: 2.1.12
Precedence: junk
List-Id: Development discussions about the libvirt library & tools
	<libvir-list.redhat.com>
List-Unsubscribe: <https://www.redhat.com/mailman/options/libvir-list>,
	<mailto:libvir-list-request@redhat.com?subject=unsubscribe>
List-Archive: <https://www.redhat.com/archives/libvir-list>
List-Post: <mailto:libvir-list@redhat.com>
List-Help: <mailto:libvir-list-request@redhat.com?subject=help>
List-Subscribe: <https://www.redhat.com/mailman/listinfo/libvir-list>,
	<mailto:libvir-list-request@redhat.com?subject=subscribe>
Sender: libvir-list-bounces@redhat.com
Errors-To: libvir-list-bounces@redhat.com
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13
Authentication-Results: relay.mimecast.com;
	auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com
X-Mimecast-Spam-Score: 0
X-Mimecast-Originator: redhat.com
Content-Transfer-Encoding: quoted-printable
X-ZohoMail-DKIM: pass (identity @redhat.com)
Content-Type: text/plain; charset="utf-8"

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
---
 docs/formatdomain-devices-video.rst | 101 +++++++++++++++++++++++++++
 docs/formatdomain-devices.rst       | 103 +---------------------------
 docs/meson.build                    |   1 +
 3 files changed, 103 insertions(+), 102 deletions(-)
 create mode 100644 docs/formatdomain-devices-video.rst

diff --git a/docs/formatdomain-devices-video.rst b/docs/formatdomain-device=
s-video.rst
new file mode 100644
index 0000000000..54f84a1a8a
--- /dev/null
+++ b/docs/formatdomain-devices-video.rst
@@ -0,0 +1,101 @@
+:anchor:`<a id=3D"elementsVideo"/>`
+
+Video devices
+~~~~~~~~~~~~~
+
+A video device.
+
+::
+
+   ...
+   <devices>
+     <video>
+       <model type=3D'vga' vram=3D'16384' heads=3D'1'>
+         <acceleration accel3d=3D'yes' accel2d=3D'yes'/>
+       </model>
+       <driver name=3D'qemu'/>
+     </video>
+   </devices>
+   ...
+
+``video``
+   The ``video`` element is the container for describing video devices. For
+   backwards compatibility, if no ``video`` is set but there is a ``graphi=
cs``
+   in domain xml, then libvirt will add a default ``video`` according to t=
he
+   guest type.
+
+   For a guest of type "kvm", the default ``video`` is: ``type`` with value
+   "cirrus", ``vram`` with value "16384" and ``heads`` with value "1". By
+   default, the first video device in domain xml is the primary one, but t=
he
+   optional attribute ``primary`` ( :since:`since 1.0.2` ) 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 ( :since:`since 2.4.0` ) "virtio".
+
+``model``
+   The ``model`` element has a mandatory ``type`` attribute which takes the
+   value "vga", "cirrus", "vmvga", "xen", "vbox", "qxl" ( :since:`since 0.=
8.6`
+   ), "virtio" ( :since:`since 1.3.0` ), "gop" ( :since:`since 3.2.0` ), "=
bochs"
+   ( :since:`since 5.6.0` ), "ramfb" ( :since:`since 5.9.0` ), or "none" (
+   :since:`since 4.6.0` , depending on the hypervisor features available. =
The
+   purpose of the type ``none`` is to instruct libvirt not to add a default
+   video device in the guest (see the paragraph above). This legacy behavi=
our
+   can be inconvenient in cases where GPU mediated devices are meant to be=
 the
+   only rendering device within a guest and so specifying another ``video``
+   device along with type ``none``. Refer to Host device assignment to see=
 how
+   to add a mediated device into a guest.
+
+   You can provide the amount of video memory in kibibytes (blocks of 1024
+   bytes) using ``vram``. This is supported only for guest type of "vz", "=
qemu",
+   "vbox", "vmx" and "xen". If no value is provided the default is used. I=
f the
+   size is not a power of two it will be rounded to closest one.
+
+   The number of screen can be set using ``heads``. This is supported only=
 for
+   guests type of "vz", "kvm", "vbox" and "vmx".
+
+   For guest type of "kvm" or "qemu" and model type "qxl" there are option=
al
+   attributes. Attribute ``ram`` ( :since:` since 1.0.2` ) specifies the s=
ize of
+   the primary bar, while the attribute ``vram`` specifies the secondary b=
ar
+   size. If ``ram`` or ``vram`` are not supplied a default value is used. =
The
+   ``ram`` should also be rounded to power of two as ``vram``. There is al=
so
+   optional attribute ``vgamem`` ( :since:`since 1.2.11` ) to set the size=
 of
+   VGA framebuffer for fallback mode of QXL device. Attribute ``vram64`` (
+   :since:`since 1.3.3` ) extends secondary bar and makes it addressable as
+   64bit memory.
+
+   :since:`Since 5.9.0` , the ``model`` element may also have an optional
+   ``resolution`` sub-element. The ``resolution`` element has attributes `=
`x``
+   and ``y`` to set the minimum resolution for the video device. This
+   sub-element is valid for model types "vga", "qxl", "bochs", and "virtio=
".
+
+``acceleration``
+   Configure if video acceleration should be enabled.
+
+   ``accel2d``
+      Enable 2D acceleration (for vbox driver only, :since:`since 0.7.1` )
+   ``accel3d``
+      Enable 3D acceleration (for vbox driver :since:`since 0.7.1` , qemu =
driver
+      :since:`since 1.3.0` )
+   ``rendernode``
+      Absolute path to a host's DRI device to be used for rendering (for
+      'vhostuser' driver only, :since:`since 5.8.0` ). If none is specifie=
d,
+      libvirt will pick one available.
+
+``address``
+   The optional ``address`` sub-element can be used to tie the video devic=
e to a
+   particular PCI slot. On S390, ``address`` can be used to provide the CCW
+   address for the video device ( :since:` since 4.2.0` ).
+``driver``
+   The subelement ``driver`` can be used to tune the device:
+
+   ``name``
+      Specify the backend driver to use, either "qemu" or "vhostuser" depe=
nding
+      on the hypervisor features available ( :since:`since 5.8.0` ). "qemu=
" is
+      the default QEMU backend. "vhostuser" will use a separate vhost-user
+      process backend (for ``virtio`` device).
+   virtio options
+      `Virtio-specific options <#elementsVirtio>`__ can also be set (
+      :since:`Since 3.5.0` )
+   VGA configuration
+      Control how the video devices exposed to the guest using the ``vgaco=
nf``
+      attribute which takes the value "io", "on" or "off". At present, it'=
s only
+      applicable to the bhyve's "gop" video model type ( :since:`Since 3.5=
.0` )
diff --git a/docs/formatdomain-devices.rst b/docs/formatdomain-devices.rst
index d2aba7ba28..8d8d52731e 100644
--- a/docs/formatdomain-devices.rst
+++ b/docs/formatdomain-devices.rst
@@ -52,108 +52,7 @@ following characters: ``[a-zA-Z0-9_-]``. :since:`Since =
3.9.0`
 .. include:: formatdomain-devices-input.rst
 .. include:: formatdomain-devices-hub.rst
 .. include:: formatdomain-devices-graphics.rst
-
-:anchor:`<a id=3D"elementsVideo"/>`
-
-Video devices
-~~~~~~~~~~~~~
-
-A video device.
-
-::
-
-   ...
-   <devices>
-     <video>
-       <model type=3D'vga' vram=3D'16384' heads=3D'1'>
-         <acceleration accel3d=3D'yes' accel2d=3D'yes'/>
-       </model>
-       <driver name=3D'qemu'/>
-     </video>
-   </devices>
-   ...
-
-``video``
-   The ``video`` element is the container for describing video devices. For
-   backwards compatibility, if no ``video`` is set but there is a ``graphi=
cs``
-   in domain xml, then libvirt will add a default ``video`` according to t=
he
-   guest type.
-
-   For a guest of type "kvm", the default ``video`` is: ``type`` with value
-   "cirrus", ``vram`` with value "16384" and ``heads`` with value "1". By
-   default, the first video device in domain xml is the primary one, but t=
he
-   optional attribute ``primary`` ( :since:`since 1.0.2` ) 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 ( :since:`since 2.4.0` ) "virtio".
-
-``model``
-   The ``model`` element has a mandatory ``type`` attribute which takes the
-   value "vga", "cirrus", "vmvga", "xen", "vbox", "qxl" ( :since:`since 0.=
8.6`
-   ), "virtio" ( :since:`since 1.3.0` ), "gop" ( :since:`since 3.2.0` ), "=
bochs"
-   ( :since:`since 5.6.0` ), "ramfb" ( :since:`since 5.9.0` ), or "none" (
-   :since:`since 4.6.0` , depending on the hypervisor features available. =
The
-   purpose of the type ``none`` is to instruct libvirt not to add a default
-   video device in the guest (see the paragraph above). This legacy behavi=
our
-   can be inconvenient in cases where GPU mediated devices are meant to be=
 the
-   only rendering device within a guest and so specifying another ``video``
-   device along with type ``none``. Refer to Host device assignment to see=
 how
-   to add a mediated device into a guest.
-
-   You can provide the amount of video memory in kibibytes (blocks of 1024
-   bytes) using ``vram``. This is supported only for guest type of "vz", "=
qemu",
-   "vbox", "vmx" and "xen". If no value is provided the default is used. I=
f the
-   size is not a power of two it will be rounded to closest one.
-
-   The number of screen can be set using ``heads``. This is supported only=
 for
-   guests type of "vz", "kvm", "vbox" and "vmx".
-
-   For guest type of "kvm" or "qemu" and model type "qxl" there are option=
al
-   attributes. Attribute ``ram`` ( :since:` since 1.0.2` ) specifies the s=
ize of
-   the primary bar, while the attribute ``vram`` specifies the secondary b=
ar
-   size. If ``ram`` or ``vram`` are not supplied a default value is used. =
The
-   ``ram`` should also be rounded to power of two as ``vram``. There is al=
so
-   optional attribute ``vgamem`` ( :since:`since 1.2.11` ) to set the size=
 of
-   VGA framebuffer for fallback mode of QXL device. Attribute ``vram64`` (
-   :since:`since 1.3.3` ) extends secondary bar and makes it addressable as
-   64bit memory.
-
-   :since:`Since 5.9.0` , the ``model`` element may also have an optional
-   ``resolution`` sub-element. The ``resolution`` element has attributes `=
`x``
-   and ``y`` to set the minimum resolution for the video device. This
-   sub-element is valid for model types "vga", "qxl", "bochs", and "virtio=
".
-
-``acceleration``
-   Configure if video acceleration should be enabled.
-
-   ``accel2d``
-      Enable 2D acceleration (for vbox driver only, :since:`since 0.7.1` )
-   ``accel3d``
-      Enable 3D acceleration (for vbox driver :since:`since 0.7.1` , qemu =
driver
-      :since:`since 1.3.0` )
-   ``rendernode``
-      Absolute path to a host's DRI device to be used for rendering (for
-      'vhostuser' driver only, :since:`since 5.8.0` ). If none is specifie=
d,
-      libvirt will pick one available.
-
-``address``
-   The optional ``address`` sub-element can be used to tie the video devic=
e to a
-   particular PCI slot. On S390, ``address`` can be used to provide the CCW
-   address for the video device ( :since:` since 4.2.0` ).
-``driver``
-   The subelement ``driver`` can be used to tune the device:
-
-   ``name``
-      Specify the backend driver to use, either "qemu" or "vhostuser" depe=
nding
-      on the hypervisor features available ( :since:`since 5.8.0` ). "qemu=
" is
-      the default QEMU backend. "vhostuser" will use a separate vhost-user
-      process backend (for ``virtio`` device).
-   virtio options
-      `Virtio-specific options <#elementsVirtio>`__ can also be set (
-      :since:`Since 3.5.0` )
-   VGA configuration
-      Control how the video devices exposed to the guest using the ``vgaco=
nf``
-      attribute which takes the value "io", "on" or "off". At present, it'=
s only
-      applicable to the bhyve's "gop" video model type ( :since:`Since 3.5=
.0` )
+.. include:: formatdomain-devices-video.rst

 :anchor:`<a id=3D"elementsConsole"/>`

diff --git a/docs/meson.build b/docs/meson.build
index f26754852d..56791e3258 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -137,6 +137,7 @@ docs_rst_files =3D [
                   'formatdomain-devices-input.rst',
                   'formatdomain-devices-hub.rst',
                   'formatdomain-devices-graphics.rst',
+                  'formatdomain-devices-video.rst',
                 ]
   },
   { 'name': 'hacking' },
--=20
2.26.2