about summary refs log tree commit diff
path: root/src/docs/empty_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/empty_loop.txt
parent3597ed5a099488aa77caf444106a0550b7e5d2e8 (diff)
downloadrust-46c5a5d234f13dcf4bb4cf4241b2addedbf0be14.tar.gz
rust-46c5a5d234f13dcf4bb4cf4241b2addedbf0be14.zip
Merge commit 'f4850f7292efa33759b4f7f9b7621268979e9914' into clippyup
Diffstat (limited to 'src/docs/empty_loop.txt')
-rw-r--r--src/docs/empty_loop.txt27
1 files changed, 0 insertions, 27 deletions
diff --git a/src/docs/empty_loop.txt b/src/docs/empty_loop.txt
deleted file mode 100644
index fea49a74d04..00000000000
--- a/src/docs/empty_loop.txt
+++ /dev/null
@@ -1,27 +0,0 @@
-### What it does
-Checks for empty `loop` expressions.
-
-### Why is this bad?
-These busy loops burn CPU cycles without doing
-anything. It is _almost always_ a better idea to `panic!` than to have
-a busy loop.
-
-If panicking isn't possible, think of the environment and either:
-  - block on something
-  - sleep the thread for some microseconds
-  - yield or pause the thread
-
-For `std` targets, this can be done with
-[`std::thread::sleep`](https://doc.rust-lang.org/std/thread/fn.sleep.html)
-or [`std::thread::yield_now`](https://doc.rust-lang.org/std/thread/fn.yield_now.html).
-
-For `no_std` targets, doing this is more complicated, especially because
-`#[panic_handler]`s can't panic. To stop/pause the thread, you will
-probably need to invoke some target-specific intrinsic. Examples include:
-  - [`x86_64::instructions::hlt`](https://docs.rs/x86_64/0.12.2/x86_64/instructions/fn.hlt.html)
-  - [`cortex_m::asm::wfi`](https://docs.rs/cortex-m/0.6.3/cortex_m/asm/fn.wfi.html)
-
-### Example
-```
-loop {}
-```
\ No newline at end of file