Mirrors/rust-clippy
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-clippy synced 2024-11-24 05:33:27 +00:00
Code Issues Projects Releases Packages Wiki Activity

add comment about mutex_atomic issue to description

Browse source
This commit is contained in:
Ray Redondo 2022-12-29 14:48:36 -06:00
parent 0e5fcb7b7f
commit 0298095ac2
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
clippy_lints/src/mutex_atomic.rs
View file

@ -1,6 +1,6 @@
//! Checks for uses of mutex where an atomic value could be used
//!
//! This lint is **warn** by default
//! This lint is **allow** by default
use clippy_utils::diagnostics::span_lint;
use clippy_utils::ty::is_type_diagnostic_item;
@ -20,6 +20,10 @@ declare_clippy_lint! {
/// `std::sync::atomic::AtomicBool` and `std::sync::atomic::AtomicPtr` are leaner and
/// faster.
///
/// On the other hand, `Mutex`es are, in general, easier to
/// verify correctness. An atomic does not behave the same as
/// an equivalent mutex. See [this issue](https://github.com/rust-lang/rust-clippy/issues/4295)'s commentary for more details.
///
/// ### Known problems
/// This lint cannot detect if the mutex is actually used
/// for waiting before a critical section.
@ -40,7 +44,7 @@ declare_clippy_lint! {
#[clippy::version = "pre 1.29.0"]
pub MUTEX_ATOMIC,
restriction,
"using a mutex where an atomic value could be used instead"
"using a mutex where an atomic value could be used instead."
}
declare_clippy_lint! {