[libvirt PATCH v3 16/16] docs: document <graphics> type dbus

[marcandre.lureau at redhat.com]

From: Marc-André Lureau <marcandre.lureau at redhat.com>

Signed-off-by: Marc-André Lureau <marcandre.lureau at redhat.com>
---
 NEWS.rst              |  7 ++++++-
 docs/formatdomain.rst | 43 ++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 48 insertions(+), 2 deletions(-)

diff --git a/NEWS.rst b/NEWS.rst
index e7d53167219f..92042459653d 100644
--- a/NEWS.rst
+++ b/NEWS.rst
@@ -37,11 +37,16 @@ v8.0.0 (unreleased)
     as ``VIR_MIGRATE_NON_SHARED_SYNCHRONOUS_WRITES`` exposed via
     ``virsh migrate --copy-storage-synchronous-writes``.
 
-    * Introduce TCG domain features
+  * Introduce TCG domain features
 
     Libvirt is now able to set the size of translation block cache size
     (tb-size) for TCG domains.
 
+  * qemu: D-Bus display
+
+    Libvirt is now able to setup a D-Bus display export, either with a private
+    bus or in p2p mode. This display is available in QEMU 7.0.0.
+
 * **Improvements**
 
 * **Bug fixes**
diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index d4f30bb8af57..a0d11e40c2fd 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -6094,6 +6094,39 @@ interaction with the admin.
            <gl rendernode='/dev/dri/renderD128'/>
          </graphics>
 
+   ``dbus``:since:`Since 8.0.0`
+      Export the display over D-Bus. By default, it will use a private bus,
+      except when ``p2p`` or ``address`` are specified.
+
+      ::
+
+        <graphics type='dbus'/>
+
+      ``p2p`` (accepts ``on`` or ``off``) enables peer-to-peer connections,
+      established through virDomainOpenGraphics() APIs.
+
+      ``address`` (accepts a `D-Bus address
+      <https://dbus.freedesktop.org/doc/dbus-specification.html#addresses>`_),
+      will connect to the specified bus address.
+
+      This element accepts a ``<gl/>`` sub-element with an optional attribute
+      ``rendernode`` which can be used to specify an absolute path to a host's
+      DRI device to be used for OpenGL rendering.
+
+      Copy & Paste functionality (via Spice agent) is set by the ``clipboard``
+      element. It is disabled by default, and can be disabled by setting the
+      ``copypaste`` property to ``yes``.
+
+      D-Bus can export an audio backend using the ``<audio>`` sub-element:
+
+      ::
+
+         <graphics type='dbus' ...>
+           <audio id='1'>
+         </graphics>
+
+      Where ``1`` is an id of the `audio device <#elementsAudio>`__.
+
 Graphics device uses a ``<listen>`` to set up where the device should listen for
 clients. It has a mandatory attribute ``type`` which specifies the listen type.
 Only ``vnc``, ``spice`` and ``rdp`` supports ``<listen>`` element. :since:`Since
@@ -7007,7 +7040,7 @@ to the guest sound device.
 ``type``
    The required ``type`` attribute specifies audio backend type.
    Currently, the supported values are 'none', 'alsa', 'coreaudio',
-   'jack', 'oss', 'pulseaudio', 'sdl', 'spice', 'file'.
+   'dbus', jack', 'oss', 'pulseaudio', 'sdl', 'spice', 'file'.
 
 ``id``
    Integer id of the audio device. Must be greater than 0.
@@ -7134,6 +7167,14 @@ and ``<output>`` elements
 
 :since:`Since 7.2.0, qemu`
 
+D-Bus audio backend
+^^^^^^^^^^^^^^^^^^^
+
+The 'dbus' audio backend does not connect to any host audio framework. It
+exports a D-Bus interface when associated with a D-Bus display.
+
+:since:`Since 8.0.0, qemu`
+
 Jack audio backend
 ^^^^^^^^^^^^^^^^^^
 
-- 
2.34.1.8.g35151cf07204