about summary refs log tree commit diff
path: root/src/docs/mutex_atomic.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/docs/mutex_atomic.txt')
-rw-r--r--src/docs/mutex_atomic.txt22
1 files changed, 0 insertions, 22 deletions
diff --git a/src/docs/mutex_atomic.txt b/src/docs/mutex_atomic.txt
deleted file mode 100644
index 062ac8b323b..00000000000
--- a/src/docs/mutex_atomic.txt
+++ /dev/null
@@ -1,22 +0,0 @@
-### What it does
-Checks for usages of `Mutex<X>` where an atomic will do.
-
-### Why is this bad?
-Using a mutex just to make access to a plain bool or
-reference sequential is shooting flies with cannons.
-`std::sync::atomic::AtomicBool` and `std::sync::atomic::AtomicPtr` are leaner and
-faster.
-
-### Known problems
-This lint cannot detect if the mutex is actually used
-for waiting before a critical section.
-
-### Example
-```
-let x = Mutex::new(&y);
-```
-
-Use instead:
-```
-let x = AtomicBool::new(y);
-```
\ No newline at end of file