From 4b9359ba77603a8a1dd19dbf2272f6023f4ea345 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Kr=C3=B6ning?= Date: Wed, 7 Apr 2021 13:38:40 +0200 Subject: [PATCH] Fix documented type for entry point function --- src/boot_info.rs | 2 +- src/lib.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/boot_info.rs b/src/boot_info.rs index 08fa69d4..adb97bc6 100644 --- a/src/boot_info.rs +++ b/src/boot_info.rs @@ -8,7 +8,7 @@ use core::{ops, slice}; /// ``` /// # use bootloader::BootInfo; /// # type _SIGNATURE = -/// extern "C" fn(boot_info: &'static BootInfo) -> !; +/// extern "C" fn(boot_info: &'static mut BootInfo) -> !; /// ``` /// /// Note that no type checking occurs for the entry point function, so be careful to diff --git a/src/lib.rs b/src/lib.rs index 27b916de..de1eebb7 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -104,7 +104,7 @@ compile_error!("This crate only supports the x86_64 architecture."); /// Defines the entry point function. /// -/// The function must have the signature `fn(&'static BootInfo) -> !`. +/// The function must have the signature `fn(&'static mut BootInfo) -> !`. /// /// This macro just creates a function named `_start`, which the linker will use as the entry /// point. The advantage of using this macro instead of providing an own `_start` function is