Skip to content

Commit

Permalink
doc/api-reference: Add note about the future of the registry API
Browse files Browse the repository at this point in the history
Since the plan is for apps to eventually ensure they are placed in the
right cgroup and rely on the portal to derive the app ID from the cgroup
name, mention this in the api reference.
  • Loading branch information
jadahl committed Feb 13, 2025
1 parent 88a0146 commit 6c72d5c
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/api-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ This might improve the user experience when the host app was launched in a way
that doesn't follow the standard. See
:doc:`org.freedesktop.host.portal.Registry <doc-org.freedesktop.host.portal.Registry>`

Disclaimer: The host app calls to the registry will eventually be replacable
with the app placing itself in a cgroup named according to specific naming
conventions. It will be documented in
:doc:`org.freedesktop.host.portal.Registry <doc-org.freedesktop.host.portal.Registry>` when this will be possible.

All apps have access to the portals below:

.. toctree::
Expand Down

0 comments on commit 6c72d5c

Please sign in to comment.