Skip to content

Commit 80c41b2

Browse files
committed
multiboot2: streamline before release
1 parent b847884 commit 80c41b2

File tree

2 files changed

+9
-13
lines changed

2 files changed

+9
-13
lines changed

multiboot2/Cargo.toml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[package]
22
name = "multiboot2"
33
description = """
4-
Library that assists parsing the Multiboot2 Information Structure (MBI) from
5-
Multiboot2-compliant bootloaders, such as GRUB. It supports all tags from the
6-
specification including full support for the sections of ELF files. This library
7-
is `no_std` and can be used in a Multiboot2-kernel.
4+
Convenient and safe parsing of Multiboot2 Information Structures (MBI) and its
5+
corresponding tags. Usable in `no_std` environments, such as a kernel. An
6+
optional builder feature also allows the construction of the corresponding
7+
structures.
88
"""
99
version = "0.22.0"
1010
authors = [

multiboot2/README.md

+5-9
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
# multiboot2
22

3-
![Build](https://github.com/rust-osdev/multiboot2/actions/workflows/rust.yml/badge.svg)
43
[![crates.io](https://img.shields.io/crates/v/multiboot2.svg)](https://crates.io/crates/multiboot2)
54
[![docs](https://docs.rs/multiboot2/badge.svg)](https://docs.rs/multiboot2/)
65

7-
Library that assists parsing the Multiboot2 Information Structure (MBI) from
8-
Multiboot2-compliant bootloaders, such as GRUB. It supports all tags from the
9-
specification including full support for the sections of ELF files. This library
10-
is `no_std` and can be used in a Multiboot2-kernel.
6+
Convenient and safe parsing of Multiboot2 Information Structures (MBI) and its
7+
corresponding tags. Usable in `no_std` environments, such as a kernel. An
8+
optional builder feature also allows the construction of the corresponding
9+
structures.
1110

1211
It follows the Multiboot 2.0 specification
1312
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`-
1918
feature requires the `alloc`-crate and an `#[global_allocator]` to be available.
2019
You need the `builder` only if you want to construct new boot information
2120
structures at runtime. For parsing, this is not relevant, and you can
22-
deactivate the default feature.
21+
deactivate the default features.
2322

2423
## Background: The Multiboot 2 Information Structure
2524

@@ -40,9 +39,6 @@ There are many different types of tags, but they all have the same beginning:
4039
size | u32
4140
other fields | variable
4241

43-
All tags and the mbi itself are 8-byte aligned. The last tag must be the _end
44-
tag_, which is a tag of type `0` and size `8`.
45-
4642
## MSRV
4743

4844
The MSRV is 1.70.0 stable.

0 commit comments

Comments
 (0)