Skip to content

Commit d2f162a

Browse files
authored
Fix documented type for entry point function (#147)
1 parent d9c6a8f commit d2f162a

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

Diff for: src/boot_info.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use core::{ops, slice};
88
/// ```
99
/// # use bootloader::BootInfo;
1010
/// # type _SIGNATURE =
11-
/// extern "C" fn(boot_info: &'static BootInfo) -> !;
11+
/// extern "C" fn(boot_info: &'static mut BootInfo) -> !;
1212
/// ```
1313
///
1414
/// Note that no type checking occurs for the entry point function, so be careful to

Diff for: src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ compile_error!("This crate only supports the x86_64 architecture.");
104104

105105
/// Defines the entry point function.
106106
///
107-
/// The function must have the signature `fn(&'static BootInfo) -> !`.
107+
/// The function must have the signature `fn(&'static mut BootInfo) -> !`.
108108
///
109109
/// This macro just creates a function named `_start`, which the linker will use as the entry
110110
/// point. The advantage of using this macro instead of providing an own `_start` function is

0 commit comments

Comments
 (0)