Skip to content

Commit bea5b9c

Browse files
committed
uefi: improve doc about alloc feature
1 parent 920e50b commit bea5b9c

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

uefi/src/lib.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,13 @@
126126
//!
127127
//! - `alloc`: Enable functionality requiring the [`alloc`] crate from
128128
//! the Rust standard library. For example, methods that return a
129-
//! `Vec` rather than filling a statically-sized array. This requires
130-
//! a global allocator; you can use the `global_allocator` feature or
131-
//! provide your own. This is independent of internal direct usages of the
129+
//! `Vec` rather than filling a statically-sized array.
130+
//! We **highly recommend** activating this feature as more and more
131+
//! functionality in `uefi-rs` depends and will depend on `alloc` for
132+
//! convenience and good developer experience.
133+
//! The `alloc` feature requires a global allocator: you can use the
134+
//! `global_allocator` feature or provide your own. The global allocator and
135+
//! the `alloc` feature are independent of internal direct usages of the
132136
//! UEFI boot service allocator which may happen anyway, where necessary.
133137
//! - `global_allocator`: Set [`allocator::Allocator`] as the global Rust
134138
//! allocator. This is a simple allocator that relies on the UEFI pool

0 commit comments

Comments
 (0)