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

Add docs for lib bindings with supported library versions #14900

Merged
merged 9 commits into from
Nov 15, 2024

Conversation

straight-shoota
Copy link
Member

Adds documentation about which library versions are supported by the various lib bindings.

I'm planning to put that information on https://crystal-lang.org/reference/1.13/man/required_libraries.html as well. The URLs to this page should hopefully remind us to sync updates there.

Ref #11358 (comment)

@Blacksmoke16
Copy link
Member

Would be nice if we could leverage/improve https://github.com/crystal-lang/shards/blob/655a3b0fc416986dae1846ded3856aaf46198085/docs/shard.yml.adoc?plain=1#L176-L205 more to have this available in a more idiomatic way.

src/llvm/lib_llvm.cr Outdated Show resolved Hide resolved
Co-authored-by: Quinton Miller <[email protected]>
@straight-shoota
Copy link
Member Author

@Blacksmoke16 Yes, a structured format could be nice. But not sure how that would look like. A plain mapping between lib name and a version selector is not always sufficient.
So it's best to start with this and maybe figure out some more elaborate notation later.

@straight-shoota straight-shoota added this to the 1.15.0 milestone Nov 14, 2024
@straight-shoota straight-shoota merged commit 6cec6a9 into crystal-lang:master Nov 15, 2024
69 checks passed
@straight-shoota straight-shoota deleted the feat/lib-vesions branch November 15, 2024 10:12
straight-shoota added a commit that referenced this pull request Nov 15, 2024
Fixup for #14900
The version info was updated to 4.0 for `lib_ssl` but not `lib_crypto`.
straight-shoota added a commit that referenced this pull request Nov 16, 2024
The version info was updated to 4.0 for `lib_ssl` but not `lib_crypto`.
straight-shoota added a commit to crystal-lang/crystal-book that referenced this pull request Nov 16, 2024
Adds information about supported library versions, as taken from crystal-lang/crystal#14900
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants