about summary refs log tree commit diff
path: root/src/docs/missing_spin_loop.txt
diff options
context:
space:
mode:
authorPhilipp Krones <hello@philkrones.com>2022-11-21 20:34:47 +0100
committerPhilipp Krones <hello@philkrones.com>2022-11-21 20:51:52 +0100
commit46c5a5d234f13dcf4bb4cf4241b2addedbf0be14 (patch)
tree56726625e55224ecb09ed11f509a964507b9c333 /src/docs/missing_spin_loop.txt
parent3597ed5a099488aa77caf444106a0550b7e5d2e8 (diff)
downloadrust-46c5a5d234f13dcf4bb4cf4241b2addedbf0be14.tar.gz
rust-46c5a5d234f13dcf4bb4cf4241b2addedbf0be14.zip
Merge commit 'f4850f7292efa33759b4f7f9b7621268979e9914' into clippyup
Diffstat (limited to 'src/docs/missing_spin_loop.txt')
-rw-r--r--src/docs/missing_spin_loop.txt27
1 files changed, 0 insertions, 27 deletions
diff --git a/src/docs/missing_spin_loop.txt b/src/docs/missing_spin_loop.txt
deleted file mode 100644
index 3a06a91d718..00000000000
--- a/src/docs/missing_spin_loop.txt
+++ /dev/null
@@ -1,27 +0,0 @@
-### What it does
-Check for empty spin loops
-
-### Why is this bad?
-The loop body should have something like `thread::park()` or at least
-`std::hint::spin_loop()` to avoid needlessly burning cycles and conserve
-energy. Perhaps even better use an actual lock, if possible.
-
-### Known problems
-This lint doesn't currently trigger on `while let` or
-`loop { match .. { .. } }` loops, which would be considered idiomatic in
-combination with e.g. `AtomicBool::compare_exchange_weak`.
-
-### Example
-
-```
-use core::sync::atomic::{AtomicBool, Ordering};
-let b = AtomicBool::new(true);
-// give a ref to `b` to another thread,wait for it to become false
-while b.load(Ordering::Acquire) {};
-```
-Use instead:
-```
-while b.load(Ordering::Acquire) {
-    std::hint::spin_loop()
-}
-```
\ No newline at end of file