Skip to content
This repository has been archived by the owner on Nov 1, 2021. It is now read-only.

Make wlr_xcursor_manager_load() return a bool #2195

Merged
merged 1 commit into from
May 18, 2020

Conversation

ifreund
Copy link
Member

@ifreund ifreund commented May 14, 2020

This is currently inconsistent with the rest of the library and a bit of
a footgun for new compositors. However, this breaks the API in a very
unfortunate way for existing compositors.


Breaking change: wlr_xcursor_manager_load now returns a bool, making it consistent with other wlroots functions. Compositors that check the return value need to invert their check.

This is currently inconsistent with the rest of the library and a bit of
a footgun for new compositors. However, this breaks the API in a very
unfortunate way for existing compositors.
@emersion emersion added the breaking Breaking change in public API label May 14, 2020
@ifreund
Copy link
Member Author

ifreund commented May 14, 2020

So with regard to breaking existing compositors:

  • sway doesn't check the return value (link)
  • hikari doesn't check the return value (link)
  • wayfire doesn't check the return value (link)
  • cardboard doesn't check the return value (link)
  • tinywl doesn't check the return value (link)

This is obviously not an exhaustive list of compositors using wlroots, but I think it shows that this might not be as severe of a breaking change in effect as it seems at first glance.

Copy link
Member

@emersion emersion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM. Keeping this open for a few days in case someone has something to add.

@emersion emersion merged commit 666498d into swaywm:master May 18, 2020
@emersion
Copy link
Member

Thanks!

@ifreund ifreund deleted the xcursor-man-load-return branch May 18, 2020 15:33
@emersion emersion added this to the 0.11.0 milestone Jul 15, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
breaking Breaking change in public API
Development

Successfully merging this pull request may close these issues.

None yet

2 participants