Skip to content

Commit 010c9c3

Browse files
committed
readme fixes
1 parent 8c99426 commit 010c9c3

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

multiboot2-header/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ What this library is not optimal for:
1616
- compiling a Multiboot2 header statically into an object file using only Rust code
1717

1818
## Features and `no_std` Compatibility
19-
This library is always `no_std`. However, the default `builder`-feature requires
20-
the `alloc`-crate to be available. You need the `builder` only if you want to
21-
construct new headers at run time. For parsing, this is not relevant, and you
22-
can deactivate the default feature.
19+
This library is always `no_std` without `alloc`. However, the default `builder`-
20+
feature requires the `alloc`-crate and an `#[global_allocator]` to be available.
21+
You need the `builder` only if you want to construct new headers at runtime.
22+
For parsing, this is not relevant, and you can deactivate the default feature.
2323

2424
```toml
2525
# without `builder`-feature (and without `alloc`-crate)

multiboot2/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ is `no_std` and can be used in a Multiboot2-kernel.
1111
It follows the Multiboot 2.0 specification at https://www.gnu.org/software/grub/manual/multiboot2/multiboot.html and the ELF 64 specification at http://www.uclibc.org/docs/elf-64-gen.pdf.
1212

1313
## Features and `no_std` Compatibility
14-
This library is always `no_std`. However, the default `builder`-feature requires
15-
the `alloc`-crate to be available. You need the `builder` only if you want to
16-
construct new boot information structures at run time. For parsing, this is not
17-
relevant, and you can deactivate the default feature.
14+
This library is always `no_std` without `alloc`. However, the default `builder`-
15+
feature requires the `alloc`-crate and an `#[global_allocator]` to be available.
16+
You need the `builder` only if you want to construct new boot information
17+
structures at runtime. For parsing, this is not relevant, and you can
18+
deactivate the default feature.
1819

1920
## Background: The Multiboot 2 Information Structure
2021
The Multiboot information structure looks like this:

0 commit comments

Comments
 (0)