Skip to content

SDL compatible versions in readme should be 2.0.14+ #1244

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

Closed
caspark opened this issue Aug 18, 2022 · 1 comment · Fixed by #1246
Closed

SDL compatible versions in readme should be 2.0.14+ #1244

caspark opened this issue Aug 18, 2022 · 1 comment · Fixed by #1246
Labels

Comments

@caspark
Copy link
Contributor

caspark commented Aug 18, 2022

The readme currently says:

SDL2 >= 2.0.8 is recommended to use these bindings, but note that SDL2 >= 2.0.5 is also supported. Below 2.0.5, you may experience link-time errors as some functions are used here but are not defined in SDL2.

I had a project which had 2.0.10 dlls checked in; upon bumping from 0.34.3 to 0.35.2 of rust-sdl2 I got a link error for my Windows build along the lines of unresolved external symbol "SDL_OpenURL" referenced in <mangled function name>.

Looks like SDL_OpenURL was only added in SDL's 2.0.14 release, so when #1138 added the binding for SDL_OpenURL to address #1119 as part of the 0.35 release then that inadvertently dropped support for earlier SDL versions.

I wasn't using OpenURL since it didn't exist in my old version, but bumping to the latest 2.0.22-devel dlls in my project did indeed fix my linking error.

So it seems like the readme should read something like this:

SDL2 >= 2.0.14 is required to use these bindings; below 2.0.14, you may experience link-time errors as some functions are used here but are not defined in SDL2.

And changelog.md for v0.35.0 should probably be updated to note the possibly-breaking change of dropping support for SDL2 versions older than 2.0.14?

Or am I missing something? (could well be - e.g. from the current readme text I infer that it might be possible to suppress link errors from using an old SDL2 version, but I have not heard of such a thing before)

@Cobrand Cobrand added the doc label Aug 18, 2022
@Cobrand
Copy link
Member

Cobrand commented Aug 18, 2022

I don't think you're missing anything, the doc just needs to be updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants