lints: add #![forbid] lints per crate
#375
Open
Conversation
This file contains 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
github-actions
bot
added
A-p2p
github-actions
bot
added
A-dependency
hinto-janai
commented
Jan 26, 2025
Comment on lines
+2
to
+15
| #![forbid( | ||
| clippy::missing_assert_message, | ||
| clippy::missing_docs_in_private_items, | ||
| clippy::missing_errors_doc, | ||
| clippy::missing_panics_doc, | ||
| clippy::should_panic_without_expect, | ||
| clippy::single_char_lifetime_names, | ||
| missing_docs, | ||
| unsafe_code, | ||
| unused_results, | ||
| missing_copy_implementations, | ||
| missing_debug_implementations, | ||
| reason = "Crate-specific lints. There should be good reasoning when removing these." | ||
| )] |
There was a problem hiding this comment.
This is the full list of lints, all other crates have some subset of this. Only a few allow unsafe_code, I will list them:
| @@ -69,6 +69,7 @@ impl_thread_percent! { | |||
| /// | |||
| /// On macOS and *BSD: +20 | |||
| /// On Linux: +19 | |||
| #[expect(unsafe_code, reason = "Must call C")] | |||
There was a problem hiding this comment.
cuprate_helper uses unsafe 1 time here.
| @@ -1,5 +1,7 @@ | |||
| //! Wrapper type for partially-`unsafe` usage of `T: !Send`. | |||
|
|
|||
| #![expect(unsafe_code)] | |||
There was a problem hiding this comment.
cuprate_blockchain uses unsafe for UnsafeSendable.
| clippy::significant_drop_tightening | ||
| clippy::significant_drop_tightening, | ||
| )] | ||
| #![forbid( |
There was a problem hiding this comment.
cuprate_database uses unsafe for:
pub unsafe trait DatabaseRoheed
The #[expect]s everywhere may seem a bit messy although it does mean the rest of cuprate_database is known not to use unsafe, this may be worth it.
SyntheticBird45
approved these changes
Jan 27, 2025
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.
What
#![forbid]lints for all crates where applicableunsafe_code = "deny"toCargo.tomlWhy
Allows us to uphold certain static invariants within crates, the most useful one being
unsafe_code.Within the crates that use
unsafe, only a small portion of the crate needsunsafe. Notating the files that need it with#[expect(unsafe_code)]allows the rest of the crate to be known safe (at least the keyword, obviously usingunsafeincorrectly can cause safe code to be unsafe).I.e. it defines and restricts the
unsafeinterface to certain portions of the crate.