[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL v2 23/36] docs: add dbus-display documentation
From: |
marcandre . lureau |
Subject: |
[PULL v2 23/36] docs: add dbus-display documentation |
Date: |
Tue, 21 Dec 2021 10:58:42 +0400 |
From: Marc-André Lureau <marcandre.lureau@redhat.com>
Wire up the dbus-display documentation. The interface and feature is
implemented next.
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Acked-by: Gerd Hoffmann <kraxel@redhat.com>
---
docs/interop/dbus-display.rst | 31 +++++++++++++++++++++++++++++++
docs/interop/dbus.rst | 2 ++
docs/interop/index.rst | 1 +
ui/dbus-display1.xml | 0
4 files changed, 34 insertions(+)
create mode 100644 docs/interop/dbus-display.rst
create mode 100644 ui/dbus-display1.xml
diff --git a/docs/interop/dbus-display.rst b/docs/interop/dbus-display.rst
new file mode 100644
index 000000000000..8c6e8e0f5a82
--- /dev/null
+++ b/docs/interop/dbus-display.rst
@@ -0,0 +1,31 @@
+D-Bus display
+=============
+
+QEMU can export the VM display through D-Bus (when started with ``-display
+dbus``), to allow out-of-process UIs, remote protocol servers or other
+interactive display usages.
+
+Various specialized D-Bus interfaces are available on different object paths
+under ``/org/qemu/Display1/``, depending on the VM configuration.
+
+QEMU also implements the standard interfaces, such as
+`org.freedesktop.DBus.Introspectable
+<https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces>`_.
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. only:: sphinx4
+
+ .. dbus-doc:: ui/dbus-display1.xml
+
+.. only:: not sphinx4
+
+ .. warning::
+ Sphinx 4 is required to build D-Bus documentation.
+
+ This is the content of ``ui/dbus-display1.xml``:
+
+ .. literalinclude:: ../../ui/dbus-display1.xml
+ :language: xml
diff --git a/docs/interop/dbus.rst b/docs/interop/dbus.rst
index be596d3f418c..427debc9c504 100644
--- a/docs/interop/dbus.rst
+++ b/docs/interop/dbus.rst
@@ -108,3 +108,5 @@ QEMU Interfaces
===============
:doc:`dbus-vmstate`
+
+:doc:`dbus-display`
diff --git a/docs/interop/index.rst b/docs/interop/index.rst
index 47b9ed82bbc0..c59bac983407 100644
--- a/docs/interop/index.rst
+++ b/docs/interop/index.rst
@@ -12,6 +12,7 @@ are useful for making QEMU interoperate with other software.
bitmaps
dbus
dbus-vmstate
+ dbus-display
live-block-operations
pr-helper
qemu-ga
diff --git a/ui/dbus-display1.xml b/ui/dbus-display1.xml
new file mode 100644
index 000000000000..e69de29bb2d1
--
2.34.1.8.g35151cf07204
- [PULL v2 13/36] ui: add a gl-unblock warning timer, (continued)
- [PULL v2 13/36] ui: add a gl-unblock warning timer, marcandre . lureau, 2021/12/21
- [PULL v2 14/36] ui: simplify gl unblock & flush, marcandre . lureau, 2021/12/21
- [PULL v2 15/36] ui: dispatch GL events to all listeners, marcandre . lureau, 2021/12/21
- [PULL v2 16/36] ui: split the GL context in a different object, marcandre . lureau, 2021/12/21
- [PULL v2 17/36] ui: move qemu_spice_fill_device_address to ui/util.c, marcandre . lureau, 2021/12/21
- [PULL v2 18/36] console: save current scanout details, marcandre . lureau, 2021/12/21
- [PULL v2 19/36] scripts: teach modinfo to skip non-C sources, marcandre . lureau, 2021/12/21
- [PULL v2 20/36] docs/sphinx: add sphinx modules to include D-Bus documentation, marcandre . lureau, 2021/12/21
- [PULL v2 21/36] backends: move dbus-vmstate1.xml to backends/, marcandre . lureau, 2021/12/21
- [PULL v2 22/36] docs: move D-Bus VMState documentation to source XML, marcandre . lureau, 2021/12/21
- [PULL v2 23/36] docs: add dbus-display documentation,
marcandre . lureau <=
- [PULL v2 24/36] build-sys: set glib dependency version, marcandre . lureau, 2021/12/21
- [PULL v2 25/36] ui: add a D-Bus display backend, marcandre . lureau, 2021/12/21
- [PULL v2 26/36] ui/dbus: add p2p=on/off option, marcandre . lureau, 2021/12/21
- [PULL v2 27/36] tests/qtests: add qtest_qmp_add_client(), marcandre . lureau, 2021/12/21
- [PULL v2 28/36] tests: start dbus-display-test, marcandre . lureau, 2021/12/21
- [PULL v2 29/36] audio: add "dbus" audio backend, marcandre . lureau, 2021/12/21
- [PULL v2 30/36] ui/dbus: add clipboard interface, marcandre . lureau, 2021/12/21
- [PULL v2 31/36] chardev: teach socket to accept no addresses, marcandre . lureau, 2021/12/21
- [PULL v2 32/36] chardev: make socket derivable, marcandre . lureau, 2021/12/21
- [PULL v2 33/36] option: add g_auto for QemuOpts, marcandre . lureau, 2021/12/21