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

Fix and clarify license in crate metadata and add missing license files #1308

Merged
merged 1 commit into from
Nov 12, 2023
Merged

Conversation

decathorpe
Copy link
Contributor

I am responsible for packaging some crates from this project for Fedora Linux, and have noticed that there are some issues with the license metadata / missing license files in published crates. I see that there are also reported issues for this (#912, #972, #1249), and attempted to fix the issues reported there, and some issues I noticed myself:


It appears that the project was intentionally relicensed from BSD-3-Clause to Apache-2.0 in commit d81a895, but this was, at least in part, not updated in crate metadata. This results in crates.io and tools like cargo-license to show the wrong license for some crates in this project. To address this, I adapted the package.license field in Cargo.toml files for the nalgebra, and nalgebra-glm accordingly.


The nalgebra-lapack crate is MIT licensed (there is a license file for the MIT license included, and the documentation agrees), but the crate metadata claims the crate is BSD-3-Clause licensed. Maybe this is a copy-paste error from when the crate was originally imported? To address this discrepancy, I changed the package.license field in Cargo.toml from BSD-3-Clause to MIT.


One of the terms of the Apache-2.0 license is that any (re)distributed sources contain a copy of the license text. This is currently not the case for the nalgebra-glm, nalgebra-macros, and nalgebra-sparse crates. This is problematic for Linux distributions that package these crates, and potentially also for publishing them on crates.io. Adding a symbolic link to the LICENSE file from the project's root directory should cause cargo package / cargo publish to properly include this file when publishing.

@sebcrozet sebcrozet merged commit f8cd2d4 into dimforge:dev Nov 12, 2023
10 of 12 checks passed
@sebcrozet
Copy link
Member

Your analysis checks out. Thanks!

@decathorpe
Copy link
Contributor Author

Great - thank you! 🎉

@decathorpe
Copy link
Contributor Author

It looks like new releases of this project are currently getting pushed from the dev-0.32.x branch. Would it be possible to cherry-pick this change onto that branch as well, so that it actually starts showing up in releases?

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

Successfully merging this pull request may close these issues.

2 participants