Skip to content

Commit d71de94

Browse files
uefi: Simplify features list in README
Link to the src/lib.rs file instead of listing out the optional features so that we don't have to worry about keeping the text in sync.
1 parent c2d966d commit d71de94

File tree

1 file changed

+2
-12
lines changed

1 file changed

+2
-12
lines changed

uefi/README.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,12 @@ Check out the [UEFI application template] for a quick start.
2424

2525
## Optional features
2626

27-
- `alloc`: Enables functionality requiring the `alloc` crate from the Rust standard library.
28-
- For example, this allows many convenient `uefi-rs` functions to operate on heap data (`Box`).
29-
- It is up to the user to provide a `#[global_allocator]`.
30-
- `global_allocator`: implements a `#[global_allocator]` using UEFI functions.
31-
- This allows you to use all abstractions from the `alloc` crate from the Rust standard library
32-
during runtime. Hence, `Vec`, `Box`, etc. will be able to allocate memory.
33-
**This is optional**, so you can provide a custom `#[global_allocator]` as well.
34-
- There's no guarantee of the efficiency of UEFI's allocator.
35-
- `logger`: logging implementation for the standard [`log`] crate.
36-
- Prints output to UEFI console.
37-
- No buffering is done: this is not a high-performance logger.
27+
This crate's features are described in [`src/lib.rs`].
3828

3929
See also the [`uefi-services`] crate, which provides a panic handler and
4030
initializes the `global_allocator` and `logger` features.
4131

42-
[`log`]: https://github.com/rust-lang-nursery/log
32+
[`src/lib.rs`]: src/lib.rs
4333
[`uefi-services`]: https://crates.io/crates/uefi-services
4434

4535
## Documentation

0 commit comments

Comments
 (0)