From 02b705162c3d37953d7824e832cdada7cc1b39fe Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Tue, 6 Aug 2024 15:21:20 +1000 Subject: [PATCH] data: Document the session_handle type mismatch This was erroneously implemented as `s` but for backwards compatibility cannot be changed as it would break existing clients. Best we can do here is fix the documentation and tell people about it. See eebb04172d00 ("use correct type for the session object path") and its revert in e4523531c. Closes #1359 --- data/org.freedesktop.portal.GlobalShortcuts.xml | 6 +++++- data/org.freedesktop.portal.Inhibit.xml | 6 +++++- data/org.freedesktop.portal.RemoteDesktop.xml | 6 +++++- data/org.freedesktop.portal.ScreenCast.xml | 6 +++++- 4 files changed, 20 insertions(+), 4 deletions(-) diff --git a/data/org.freedesktop.portal.GlobalShortcuts.xml b/data/org.freedesktop.portal.GlobalShortcuts.xml index 51eef116e..20800f008 100644 --- a/data/org.freedesktop.portal.GlobalShortcuts.xml +++ b/data/org.freedesktop.portal.GlobalShortcuts.xml @@ -67,11 +67,15 @@ The following results get returned via the :ref:`org.freedesktop.portal.Request::Response` signal: - * ``session_handle`` (``o``) + * ``session_handle`` (``s``) The session handle. An object path for the org.freedesktop.portal.Session object representing the created session. + + .. note:: + The ``session_handle`` is an object path that was erroneously implemented + as ``s``. For backwards compatibility it will remain this type. --> diff --git a/data/org.freedesktop.portal.Inhibit.xml b/data/org.freedesktop.portal.Inhibit.xml index eeb870ba9..c212d035b 100644 --- a/data/org.freedesktop.portal.Inhibit.xml +++ b/data/org.freedesktop.portal.Inhibit.xml @@ -99,12 +99,16 @@ The following results get returned via the :ref:`org.freedesktop.portal.Request::Response` signal: - * ``session_handle`` (``o``) + * ``session_handle`` (``s``) The session handle. An object path for the :ref:`org.freedesktop.portal.Session` object representing the created session. + .. note:: + The ``session_handle`` is an object path that was erroneously implemented + as ``s``. For backwards compatibility it will remain this type. + This method was added in version 2 of this interface. --> diff --git a/data/org.freedesktop.portal.RemoteDesktop.xml b/data/org.freedesktop.portal.RemoteDesktop.xml index dcd4cc245..7ff377029 100644 --- a/data/org.freedesktop.portal.RemoteDesktop.xml +++ b/data/org.freedesktop.portal.RemoteDesktop.xml @@ -67,11 +67,15 @@ The following results get returned via the :ref:`org.freedesktop.portal.Request::Response` signal: - * ``session_handle`` (``o``) + * ``session_handle`` (``s``) The session handle. An object path for the :ref:`org.freedesktop.portal.Session` object representing the created session. + + .. note:: + The ``session_handle`` is an object path that was erroneously implemented + as ``s``. For backwards compatibility it will remain this type. --> diff --git a/data/org.freedesktop.portal.ScreenCast.xml b/data/org.freedesktop.portal.ScreenCast.xml index d2c7baf10..7387621ba 100644 --- a/data/org.freedesktop.portal.ScreenCast.xml +++ b/data/org.freedesktop.portal.ScreenCast.xml @@ -54,11 +54,15 @@ The following results get returned via the :ref:`org.freedesktop.portal.Request::Response` signal: - * ``session_handle`` (``o``) + * ``session_handle`` (``s``) The session handle. An object path for the :ref:`org.freedesktop.portal.Session` object representing the created session. + + .. note:: + The ``session_handle`` is an object path that was erroneously implemented + as ``s``. For backwards compatibility it will remain this type. -->