Skip to content

Commit 02b7051

Browse files
whotjadahl
authored andcommitted
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 eebb041 ("use correct type for the session object path") and its revert in e452353. Closes #1359
1 parent 9481527 commit 02b7051

4 files changed

+20
-4
lines changed

data/org.freedesktop.portal.GlobalShortcuts.xml

+5-1
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,15 @@
6767
6868
The following results get returned via the :ref:`org.freedesktop.portal.Request::Response` signal:
6969
70-
* ``session_handle`` (``o``)
70+
* ``session_handle`` (``s``)
7171
7272
The session handle. An object path for the
7373
org.freedesktop.portal.Session object representing the created
7474
session.
75+
76+
.. note::
77+
The ``session_handle`` is an object path that was erroneously implemented
78+
as ``s``. For backwards compatibility it will remain this type.
7579
-->
7680
<method name="CreateSession">
7781
<arg type="a{sv}" name="options" direction="in"/>

data/org.freedesktop.portal.Inhibit.xml

+5-1
Original file line numberDiff line numberDiff line change
@@ -99,12 +99,16 @@
9999
100100
The following results get returned via the :ref:`org.freedesktop.portal.Request::Response` signal:
101101
102-
* ``session_handle`` (``o``)
102+
* ``session_handle`` (``s``)
103103
104104
The session handle. An object path for the
105105
:ref:`org.freedesktop.portal.Session` object representing the created
106106
session.
107107
108+
.. note::
109+
The ``session_handle`` is an object path that was erroneously implemented
110+
as ``s``. For backwards compatibility it will remain this type.
111+
108112
This method was added in version 2 of this interface.
109113
-->
110114
<method name="CreateMonitor">

data/org.freedesktop.portal.RemoteDesktop.xml

+5-1
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,15 @@
6767
6868
The following results get returned via the :ref:`org.freedesktop.portal.Request::Response` signal:
6969
70-
* ``session_handle`` (``o``)
70+
* ``session_handle`` (``s``)
7171
7272
The session handle. An object path for the
7373
:ref:`org.freedesktop.portal.Session` object representing the created
7474
session.
75+
76+
.. note::
77+
The ``session_handle`` is an object path that was erroneously implemented
78+
as ``s``. For backwards compatibility it will remain this type.
7579
-->
7680
<method name="CreateSession">
7781
<arg type="a{sv}" name="options" direction="in"/>

data/org.freedesktop.portal.ScreenCast.xml

+5-1
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,15 @@
5454
5555
The following results get returned via the :ref:`org.freedesktop.portal.Request::Response` signal:
5656
57-
* ``session_handle`` (``o``)
57+
* ``session_handle`` (``s``)
5858
5959
The session handle. An object path for the
6060
:ref:`org.freedesktop.portal.Session` object representing the created
6161
session.
62+
63+
.. note::
64+
The ``session_handle`` is an object path that was erroneously implemented
65+
as ``s``. For backwards compatibility it will remain this type.
6266
-->
6367
<method name="CreateSession">
6468
<arg type="a{sv}" name="options" direction="in"/>

0 commit comments

Comments
 (0)