From 77f3c8c65a7ced8bf4462ba7f12b79abda225e1a Mon Sep 17 00:00:00 2001
From: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com>
Date: Thu, 3 Feb 2022 12:06:21 +0100
Subject: [PATCH] add small comment to `entry_point!` macro

---
 src/lib.rs | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/lib.rs b/src/lib.rs
index d30fb4cc..954a32ef 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -117,6 +117,7 @@ compile_error!("This crate only supports the x86_64 architecture.");
 #[macro_export]
 macro_rules! entry_point {
     ($path:path) => {
+        /// Kernel entry point.
         #[export_name = "_start"]
         pub extern "C" fn __impl_start(boot_info: &'static mut $crate::boot_info::BootInfo) -> ! {
             // validate the signature of the program entry point