[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 24/37] docs: add dbus-display documentation
From: |
marcandre . lureau |
Subject: |
[PATCH v2 24/37] docs: add dbus-display documentation |
Date: |
Sun, 10 Oct 2021 01:08:25 +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>
---
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 0000000000..8c6e8e0f5a
--- /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 be596d3f41..427debc9c5 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 47b9ed82bb..c59bac9834 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 0000000000..e69de29bb2
--
2.33.0.721.g106298f7f9
- [PATCH v2 15/37] ui: simplify gl unblock & flush, (continued)
- [PATCH v2 15/37] ui: simplify gl unblock & flush, marcandre . lureau, 2021/10/09
- [PATCH v2 16/37] ui: dispatch GL events to all listeners, marcandre . lureau, 2021/10/09
- [PATCH v2 17/37] ui: split the GL context in a different object, marcandre . lureau, 2021/10/09
- [PATCH v2 18/37] ui: move qemu_spice_fill_device_address to ui/util.c, marcandre . lureau, 2021/10/09
- [PATCH v2 19/37] console: save current scanout details, marcandre . lureau, 2021/10/09
- [PATCH v2 20/37] scripts: teach modinfo to skip non-C sources, marcandre . lureau, 2021/10/09
- [PATCH v2 21/37] docs/sphinx: add sphinx modules to include D-Bus documentation, marcandre . lureau, 2021/10/09
- [PATCH v2 22/37] backends: move dbus-vmstate1.xml to backends/, marcandre . lureau, 2021/10/09
- [PATCH v2 23/37] docs: move D-Bus VMState documentation to source XML, marcandre . lureau, 2021/10/09
- [PATCH v2 25/37] build-sys: set glib dependency version, marcandre . lureau, 2021/10/09
- [PATCH v2 24/37] docs: add dbus-display documentation,
marcandre . lureau <=
- [PATCH v2 26/37] ui: add a D-Bus display backend, marcandre . lureau, 2021/10/09
- [PATCH v2 27/37] ui/dbus: add p2p=on/off option, marcandre . lureau, 2021/10/09
- [PATCH v2 28/37] tests/qtests: add qtest_qmp_add_client(), marcandre . lureau, 2021/10/09
- [PATCH v2 29/37] tests: start dbus-display-test, marcandre . lureau, 2021/10/09
- [PATCH v2 30/37] audio: add "dbus" audio backend, marcandre . lureau, 2021/10/09
- [PATCH v2 31/37] ui/dbus: add clipboard interface, marcandre . lureau, 2021/10/09
- [PATCH v2 32/37] chardev: teach socket to accept no addresses, marcandre . lureau, 2021/10/09
- [PATCH v2 33/37] chardev: make socket derivable, marcandre . lureau, 2021/10/09
- [PATCH v2 34/37] option: add g_auto for QemuOpts, marcandre . lureau, 2021/10/09