multiboot2: release v0.18.1

multiboot2/Cargo.toml

@@ -6,7 +6,7 @@ Multiboot2-compliant bootloaders, such as GRUB. It supports all tags from the
 specification including full support for the sections of ELF files. This library
 is `no_std` and can be used in a Multiboot2-kernel.
 """
-version = "0.18.0"
+version = "0.18.1"
 authors = [
     "Philipp Oppermann <dev@phil-opp.com>",
     "Calvin Lee <cyrus296@gmail.com>",

multiboot2/Changelog.md

@@ -1,5 +1,8 @@
 # CHANGELOG for crate `multiboot2`
 
+## 0.18.1 (2023-07-13)
+- Documentation improvements
+
 ## 0.18.0 (2023-07-13)
 - **BREAKING** The `TagTrait` was enhanced and now has an associated `ID`
   constant. This is only breaking to users that used `BootInformation::get_tag`

multiboot2/src/lib.rs

@@ -99,13 +99,9 @@ use crate::builder::AsBytes;
 use crate::framebuffer::UnknownFramebufferType;
 use tag::TagIter;
 
-/// Magic number that a multiboot2-compliant boot loader will store in `eax` register
-/// right before handoff to the payload (the kernel). This value can be used to check,
-/// that the kernel was indeed booted via multiboot2.
-///
-/// Caution: You might need some assembly code (e.g. GAS or NASM) first, which
-/// moves `eax` to another register, like `edi`. Otherwise it probably happens,
-/// that the Rust compiler output changes `eax` before you can access it.
+/// Magic number that a Multiboot2-compliant boot loader will use to identify
+/// the handoff. The location depends on the architecture and the targeted
+/// machine state.
 pub const MAGIC: u32 = 0x36d76289;
 
 /// Error type that describes errors while loading/parsing a multiboot2 information structure

multiboot2/src/tag_trait.rs

@@ -4,7 +4,7 @@ use crate::{Tag, TagType};
 use ptr_meta::Pointee;
 
 /// A trait to abstract over all sized and unsized tags (DSTs). For sized tags,
-/// this trait does not much. For DSTs, a `TagTrait::dst_size` implementation
+/// this trait does not much. For DSTs, a [`TagTrait::dst_size`] implementation
 /// must me provided, which returns the right size hint for the dynamically
 /// sized portion of the struct.
 ///