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

Upgrade to REUSE 4.x and REUSE.toml #127361

Closed
3 tasks done
Tracked by #99414
pietroalbini opened this issue Jul 5, 2024 · 0 comments · Fixed by #127923
Closed
3 tasks done
Tracked by #99414

Upgrade to REUSE 4.x and REUSE.toml #127361

pietroalbini opened this issue Jul 5, 2024 · 0 comments · Fixed by #127923
Labels
A-licensing Area: Compiler licensing C-enhancement Category: An issue proposing an enhancement or a PR with one.

Comments

@pietroalbini
Copy link
Member

pietroalbini commented Jul 5, 2024

REUSE 4.0.0 was recently released, which addresses all the issues we had with REUSE through the addition of REUSE.toml. We should upgrade the version of REUSE to it, and migrate from .reuse/dep5 to REUSE.toml in the repository.

Notable things of REUSE.toml that would help our use:

  • It is possible to instruct REUSE to ignore all annotations it would discover in source files and only use the annotations present in REUSE.toml. While in most cases we would not want to do that (as annotations in source files themselves is probably more accurate), we do want to override LLVM's licensing information with the boilerplate defined in .reuse/dep5/REUSE.toml. Setting precedence = "override" in REUSE.toml for LLVM only would address this.

  • REUSE now supports having multiple REUSE.tomls in a repository, which means that a submodule can now define its own licensing annotations. Before that, only the top-level .reuse/dep5 would be considered, and any other instance of that file in subdirectories or submodules would be ignored.

We should:

  • Update the version of REUSE to 4.x.x
  • Convert .reuse/dep5 into REUSE.toml
  • Revert c6eb03b and mark the LLVM annotation with precedence = "override"

Tracking issue: #99414

@pietroalbini pietroalbini added C-enhancement Category: An issue proposing an enhancement or a PR with one. A-licensing Area: Compiler licensing labels Jul 5, 2024
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Jul 5, 2024
@pietroalbini pietroalbini removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Jul 5, 2024
@bors bors closed this as completed in a7e884f Jul 22, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Jul 22, 2024
Rollup merge of rust-lang#127923 - ferrocene:use-reuse-tool-4.0, r=pietroalbini

Use reuse tool 4.0

This change upgrades us to reuse-tool 4.0.3, which has a new TOML format configuration instead of the old `.reuse/dep5` Debian-style file.

* Updated requirements file to install reuse-4.0.3
* Ran `reuse convert-dep5` to switch to new file format
* Switched over to `override` so the `REUSE.toml` file takes precedence over whatever random Copyright strings `reuse` finds in the source tree.

Should fix rust-lang#127361
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-licensing Area: Compiler licensing C-enhancement Category: An issue proposing an enhancement or a PR with one.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants