From 63f8487283f8b167846eb2562cca5b8fb504cc37 Mon Sep 17 00:00:00 2001
From: Christian Cunningham <cc@localhost>
Date: Sat, 20 Aug 2022 13:43:19 -0700
Subject: Document panic reenter

---
 src/panic_wait.rs | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'src')

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};
 
-- 
cgit v1.2.1