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

[new release] rust-staticlib-gen (3 packages) (0.1.0) #26728

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Lupus
Copy link

@Lupus Lupus commented Oct 11, 2024

Rust staticlib generation utility

CHANGES:
  • Initial release

@Lupus Lupus force-pushed the release-rust-staticlib-gen-0.1.0 branch from 52aeda4 to 44300aa Compare October 11, 2024 12:58
@mseri
Copy link
Member

mseri commented Oct 11, 2024

Thanks

@@ -0,0 +1,35 @@
opam-version: "2.0"
synopsis: "A dummy package to define staticlib virtual library"
Copy link
Member

Choose a reason for hiding this comment

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

Is this expected to be released?

It may be worth to add a bit of description to the three opam files to clarify better the differences between the three (or an example of use). You have a very nicely detailed readme where to extract the bits

Copy link
Author

Choose a reason for hiding this comment

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

Yeah, it's expected to be released, it's some sort of a sentinel or a marker (virtual dune) library that tells the end user that there are Rust dependencies somewhere down the transitive dependency closure of their project, and in order to successfully link they need to have Rust staticlib generated in their project (generated staticlib will implement that virtual dune library, and linking it in final executable should resolve dune complaints and provide the necessary external function definitions for the linker). Not an ideal way, but still much better than just staring at the linker errors complaining about missing Rust stubs.
I'll come up with something more descriptive to reflect the relationships between those 3 packages, and explain why "dummy" lib needs to be on opam repository. As my plan somewhat suggests that once users find missing virtual library implementation error from dune - they go googling what's that, they should find this opam package and it should really give them some solid explanation with further pointers on how to unblock themselves.
How much text is considered a good size for synopsis? dune does not allow multi-line strings in dune files :(

Copy link
Author

Choose a reason for hiding this comment

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

I've added description fields with more verbose explanation on what are the packages, could you please take a look? Thanks!

@Lupus Lupus force-pushed the release-rust-staticlib-gen-0.1.0 branch from 44300aa to 9494988 Compare October 12, 2024 07:46
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.

2 participants