docs(deny): correct what denies an undeterminable license - #92
Merged
Merged
Conversation
The comment I added in sshaaf#89 said the `allow` list rejects a crate whose license cannot be determined. It does not. EmbarkStudios/cargo-deny#611 made `deny` the new default for `unlicensed`, and that default is what the removed key was configuring. The outcome was right, the stated mechanism was not. Also restores the space in `allow = [`, which sshaaf#89 dropped by accident. Signed-off-by: nerdalytics <97166791+nerdalytics@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
A comment I added in #89 names the wrong mechanism. It says the
allowlist rejects a crate whose license cannot be determined, butallowgoverns licenses that are determined. EmbarkStudios/cargo-deny#611 madedenythe new default forunlicensed, and that default is what the removed key was configuring.Type of Change
Changes Made
deny.toml comment. It describes the right behavior with the wrong cause, so anyone reaching for the
allowlist to change that behavior would edit the wrong line.Whitespace. #89 also dropped the space in
allow = [by accident, so this restores it.Testing
This touches the config file only, and the value on the
allowline is unchanged.cargo deny checkgets past config validation and then needs crates.io, which my network blocks, so I have never seen this repo's policy run to completion.cargo testTest environment:
Checklist
Breaking Changes
None. This changes a comment and one space. No cargo-deny setting changes.
Additional Notes
EmbarkStudios/cargo-deny#611, merged 2024-02-23, lists under
unlicensed: "New default ofdeny, old default waswarn."