From 26ab71043d97c1b06bdd252378b64171cb95b1a9 Mon Sep 17 00:00:00 2001
From: Christian Cunningham <cc@localhost>
Date: Fri, 19 Aug 2022 21:22:18 -0700
Subject: Updated docs

---
 src/_arch/arm/cpu/boot.rs | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

(limited to 'src/_arch/arm/cpu')

diff --git a/src/_arch/arm/cpu/boot.rs b/src/_arch/arm/cpu/boot.rs
index 9ea2330..b81a16a 100644
--- a/src/_arch/arm/cpu/boot.rs
+++ b/src/_arch/arm/cpu/boot.rs
@@ -1,11 +1,19 @@
-//! Architectural boot code
-//!  # Boot code for ARM
-//!  crate::cpu::boot::arch_boot
+//! # Architectural boot code
+//!
+//! crate::cpu::boot::arch_boot
+//!
+//! ## Boot code for ARM
+//!
+//! Provides the initial handoff
+//! function from Assembly to Rust.
 
 use core::arch::global_asm;
 global_asm!(include_str!("boot.s"));
 
-/// The Rust entry of the `kernel` binary.
+/// # Rust entry of the `kernel` binary.
+///
+/// This function is unmangled so that the
+/// ASM boot code can switch to Rust safely.
 #[no_mangle]
 pub unsafe fn _start_rust() -> ! {
     crate::kernel_init()
-- 
cgit v1.2.1