Skip to content

Commit 2c021c2

Browse files
committed
multiboot2-header: preparing v0.1.1
1 parent 0f6c6a8 commit 2c021c2

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

multiboot2-header/Cargo.toml

+8-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description = """
44
Library with type definitions and parsing functions for Multiboot2 headers.
55
This library is `no_std` and can be used in bootloaders.
66
"""
7-
version = "0.1.0"
7+
version = "0.1.1"
88
authors = [
99
"Philipp Schuster <[email protected]>"
1010
]
@@ -27,6 +27,12 @@ homepage = "https://github.com/rust-osdev/multiboot2-header"
2727
repository = "https://github.com/rust-osdev/multiboot2"
2828
documentation = "https://docs.rs/multiboot2-header"
2929

30+
[features]
31+
# by default, builder is included
32+
default = ["builder"]
33+
std = []
34+
builder = ["std"]
35+
3036
[dependencies]
3137
# used for MBI tags
32-
multiboot2 = "0.12.2"
38+
multiboot2 = "0.13.2"

multiboot2-header/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@ What this library is good for:
1515
What this library is not optimal for:
1616
- compiling a Multiboot2 header statically into an object file using only Rust code
1717

18+
## Features and Usage in `no_std`
19+
This library is always `no_std`. However, the `builder`-feature requires the `alloc`-crate
20+
to be available. You need the `builder` only if you want to construct new headers. For parsing,
21+
this is not relevant.
22+
23+
```toml
24+
# without `builder`-feature (and without `alloc`-crate)
25+
multiboot2-header = { version = "<latest>", default-features = false }
26+
# else (requires `alloc`-crate)
27+
multiboot2-header = "<latest>"
28+
```
29+
1830
## Example 1: Builder + Parse
1931
```rust
2032
use multiboot2_header::builder::Multiboot2HeaderBuilder;

0 commit comments

Comments
 (0)