Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API/ABI stability undefined and unclear #129

Open
jadahl opened this issue Oct 18, 2023 · 4 comments
Open

API/ABI stability undefined and unclear #129

jadahl opened this issue Oct 18, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@jadahl
Copy link

jadahl commented Oct 18, 2023

There is no documentation about API and ABI stability of libdecor. According to @GeorgesStavracas it's unstable and unsuitable for use outside of Flatpak, but the fact is that it's packaged in distributions, and used by applications packaged in traditional distributions. Distributions need some level of stability, e.g. compatible ABI version in the library name etc. If there is none, and libportal starts breaking ABI, things like nautilus can no longer use libportal, since it'll likely for the foreseeable future still be packaged in distributions.

@matthiasclasen
Copy link
Contributor

When I started libportal, it was meant as a stopgap, for providing some library api for portals that aren't covered by toolkit apis (or aren't covered yet).

@smcv
Copy link
Contributor

smcv commented Oct 18, 2023

I thought we had reached agreement about this on #33, specifically in #33 (comment), with the policy being similar to libgnome-desktop:

  • the API is not long-term stable
  • if the ABI breaks, we will bump the SONAME
  • distributions can include libportal, but if they do, they must be prepared to do ABI transitions (which might involve patching apps for compatibility) when updating it to a new SONAME

@TingPing
Copy link
Member

TingPing commented Oct 18, 2023

Unfortunately that wasn't documented anywhere and passed along to the new maintainer :/

AFAICT it has not broken ABI in ~2 years so its not exactly a difficult library to target. I would say an ABI break shouldn't be done often or lightly. But changing ABI if the need truly arises shouldn't be a huge problem.

@matthiasclasen
Copy link
Contributor

Would be good to put the contents of that comment into writing somewhere in the repository

@TingPing TingPing added the documentation Improvements or additions to documentation label Apr 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants