qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: marcandre.lureau@redhat.com
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, richard.henderson@linaro.org,
	kraxel@redhat.com,
	"Marc-André Lureau" <marcandre.lureau@redhat.com>
Subject: [PULL 23/36] docs: add dbus-display documentation
Date: Fri, 17 Dec 2021 18:37:43 +0400	[thread overview]
Message-ID: <20211217143756.1831099-24-marcandre.lureau@redhat.com> (raw)
In-Reply-To: <20211217143756.1831099-1-marcandre.lureau@redhat.com>

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



  parent reply	other threads:[~2021-12-17 15:08 UTC|newest]

Thread overview: 38+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-17 14:37 [PULL 00/36] ui: D-Bus display backend marcandre.lureau
2021-12-17 14:37 ` [PULL 01/36] ui/vdagent: add CHECK_SPICE_PROTOCOL_VERSION marcandre.lureau
2021-12-17 14:37 ` [PULL 02/36] ui/vdagent: replace #if 0 with protocol version check marcandre.lureau
2021-12-17 14:37 ` [PULL 03/36] ui: generalize clipboard notifier marcandre.lureau
2021-12-17 14:37 ` [PULL 04/36] ui/vdagent: add serial capability support marcandre.lureau
2021-12-17 14:37 ` [PULL 05/36] ui/clipboard: add qemu_clipboard_check_serial() marcandre.lureau
2021-12-17 14:37 ` [PULL 06/36] ui/clipboard: add a clipboard reset serial event marcandre.lureau
2021-12-17 14:37 ` [PULL 07/36] hw/display: report an error if virgl initialization failed marcandre.lureau
2021-12-17 14:37 ` [PULL 08/36] virtio-gpu: use VIRTIO_GPU_RESOURCE_FLAG_Y_0_TOP marcandre.lureau
2021-12-17 14:37 ` [PULL 09/36] ui: do not delay further remote resize marcandre.lureau
2021-12-17 21:14   ` Richard Henderson
2021-12-17 14:37 ` [PULL 10/36] ui: factor out qemu_console_set_display_gl_ctx() marcandre.lureau
2021-12-17 14:37 ` [PULL 11/36] ui: associate GL context outside of display listener registration marcandre.lureau
2021-12-17 14:37 ` [PULL 12/36] ui: make gl_block use a counter marcandre.lureau
2021-12-17 14:37 ` [PULL 13/36] ui: add a gl-unblock warning timer marcandre.lureau
2021-12-17 14:37 ` [PULL 14/36] ui: simplify gl unblock & flush marcandre.lureau
2021-12-17 14:37 ` [PULL 15/36] ui: dispatch GL events to all listeners marcandre.lureau
2021-12-17 14:37 ` [PULL 16/36] ui: split the GL context in a different object marcandre.lureau
2021-12-17 14:37 ` [PULL 17/36] ui: move qemu_spice_fill_device_address to ui/util.c marcandre.lureau
2021-12-17 14:37 ` [PULL 18/36] console: save current scanout details marcandre.lureau
2021-12-17 14:37 ` [PULL 19/36] scripts: teach modinfo to skip non-C sources marcandre.lureau
2021-12-17 14:37 ` [PULL 20/36] docs/sphinx: add sphinx modules to include D-Bus documentation marcandre.lureau
2021-12-17 14:37 ` [PULL 21/36] backends: move dbus-vmstate1.xml to backends/ marcandre.lureau
2021-12-17 14:37 ` [PULL 22/36] docs: move D-Bus VMState documentation to source XML marcandre.lureau
2021-12-17 14:37 ` marcandre.lureau [this message]
2021-12-17 14:37 ` [PULL 24/36] build-sys: set glib dependency version marcandre.lureau
2021-12-17 14:37 ` [PULL 25/36] ui: add a D-Bus display backend marcandre.lureau
2021-12-17 14:37 ` [PULL 26/36] ui/dbus: add p2p=on/off option marcandre.lureau
2021-12-17 14:37 ` [PULL 27/36] tests/qtests: add qtest_qmp_add_client() marcandre.lureau
2021-12-17 14:37 ` [PULL 28/36] tests: start dbus-display-test marcandre.lureau
2021-12-17 14:37 ` [PULL 29/36] audio: add "dbus" audio backend marcandre.lureau
2021-12-17 14:37 ` [PULL 30/36] ui/dbus: add clipboard interface marcandre.lureau
2021-12-17 14:37 ` [PULL 31/36] chardev: teach socket to accept no addresses marcandre.lureau
2021-12-17 14:37 ` [PULL 32/36] chardev: make socket derivable marcandre.lureau
2021-12-17 14:37 ` [PULL 33/36] option: add g_auto for QemuOpts marcandre.lureau
2021-12-17 14:37 ` [PULL 34/36] ui/dbus: add chardev backend & interface marcandre.lureau
2021-12-17 14:37 ` [PULL 35/36] ui/dbus: register D-Bus VC handler marcandre.lureau
2021-12-17 14:37 ` [PULL 36/36] MAINTAINERS: update D-Bus section marcandre.lureau

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211217143756.1831099-24-marcandre.lureau@redhat.com \
    --to=marcandre.lureau@redhat.com \
    --cc=kraxel@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    --cc=richard.henderson@linaro.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).