Browse Source

multiboot2: streamline before release

Philipp Schuster 7 months ago
parent
commit
80c41b2956
2 changed files with 9 additions and 13 deletions
  1. 4 4
      multiboot2/Cargo.toml
  2. 5 9
      multiboot2/README.md

+ 4 - 4
multiboot2/Cargo.toml

@@ -1,10 +1,10 @@
 [package]
 [package]
 name = "multiboot2"
 name = "multiboot2"
 description = """
 description = """
-Library that assists parsing the Multiboot2 Information Structure (MBI) from
-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.
+Convenient and safe parsing of Multiboot2 Information Structures (MBI) and its
+corresponding tags. Usable in `no_std` environments, such as a kernel. An
+optional builder feature also allows the construction of the corresponding
+structures.
 """
 """
 version = "0.22.0"
 version = "0.22.0"
 authors = [
 authors = [

+ 5 - 9
multiboot2/README.md

@@ -1,13 +1,12 @@
 # multiboot2
 # multiboot2
 
 
-![Build](https://github.com/rust-osdev/multiboot2/actions/workflows/rust.yml/badge.svg)
 [![crates.io](https://img.shields.io/crates/v/multiboot2.svg)](https://crates.io/crates/multiboot2)
 [![crates.io](https://img.shields.io/crates/v/multiboot2.svg)](https://crates.io/crates/multiboot2)
 [![docs](https://docs.rs/multiboot2/badge.svg)](https://docs.rs/multiboot2/)
 [![docs](https://docs.rs/multiboot2/badge.svg)](https://docs.rs/multiboot2/)
 
 
-Library that assists parsing the Multiboot2 Information Structure (MBI) from
-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.
+Convenient and safe parsing of Multiboot2 Information Structures (MBI) and its
+corresponding tags. Usable in `no_std` environments, such as a kernel. An
+optional builder feature also allows the construction of the corresponding
+structures.
 
 
 It follows the Multiboot 2.0 specification
 It follows the Multiboot 2.0 specification
 at https://www.gnu.org/software/grub/manual/multiboot2/multiboot.html and the
 at https://www.gnu.org/software/grub/manual/multiboot2/multiboot.html and the
@@ -19,7 +18,7 @@ This library is always `no_std` without `alloc`. However, the default `builder`-
 feature requires the `alloc`-crate and an `#[global_allocator]` to be available.
 feature requires the `alloc`-crate and an `#[global_allocator]` to be available.
 You need the `builder` only if you want to construct new boot information
 You need the `builder` only if you want to construct new boot information
 structures at runtime. For parsing, this is not relevant, and you can
 structures at runtime. For parsing, this is not relevant, and you can
-deactivate the default feature.
+deactivate the default features.
 
 
 ## Background: The Multiboot 2 Information Structure
 ## Background: The Multiboot 2 Information Structure
 
 
@@ -40,9 +39,6 @@ There are many different types of tags, but they all have the same beginning:
  size         | u32
  size         | u32
  other fields | variable
  other fields | variable
 
 
-All tags and the mbi itself are 8-byte aligned. The last tag must be the _end
-tag_, which is a tag of type `0` and size `8`.
-
 ## MSRV
 ## MSRV
 
 
 The MSRV is 1.70.0 stable.
 The MSRV is 1.70.0 stable.