Document panic reenter

1 files changed, 6 insertions, 0 deletions

diff --git a/src/panic_wait.rs b/src/panic_wait.rs
index 2181869..a9dfba3 100644
--- a/src/panic_wait.rs
+++ b/src/panic_wait.rs
@@ -5,6 +5,12 @@
 use crate::{cpu,println};
 use core::panic::PanicInfo;
 
+/// # Prevent Double Faulting
+///
+/// An atomic operation is used to mark that
+/// a fault has occurred. If it detects that
+/// there was already a fault, it spins to
+/// prevent a recursive faulting cycle.
 fn panic_prevent_reenter() {
 	use core::sync::atomic::{AtomicBool, Ordering};