Skip to content

Commit c3841fd

Browse files
committed
Documentation touchup
1 parent 926b1fe commit c3841fd

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

static-alloc/Readme.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,8 @@ only memory guaranteed is your program's image in memory as provided by the
1414
loader. Possible use cases are OS-less development, embedded, bootloaders (even
1515
stage0/1).
1616

17-
Possible use cases are OS-less development, embedded, bootloaders (even
18-
stage0/1 maybe, totally untested). The primary goals are similar to the
19-
standard library simplicity, and correctness, and minimal assumptions.
17+
The primary goals are similar to the standard library simplicity, and
18+
correctness, and minimal assumptions.
2019

2120
## Usage
2221

static-alloc/src/lib.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,13 @@
22
//!
33
//! Provides an allocator for extremely resource constrained environments where the only memory
44
//! guaranteed is your program's image in memory as provided by the loader. Possible use cases are
5-
//! OS-less development, embedded, bootloaders (even stage0/1 maybe, totally untested).
5+
//! OS-less development, embedded, bootloaders (even stage0/1).
66
//!
7+
//! The allocator does not support meaningful deallocation but the whole allocator itself can be
8+
//! reset by mutable reference. This is useful for a local, single thread allocator. It's
9+
//! recommended to use the global instance to split resources _once_ at startup and then utilize
10+
//! multiple local allocators for actual working memory. See [`doc`] for some use case studies with
11+
//! examples.
712
//!
813
//! ## Usage – Global allocator
914
//!
@@ -35,8 +40,7 @@
3540
//! dynamic values without accidentally exposing or using uninitialized memory. This allows
3641
//! obtaining `&'static mut T` instances which is handy if a struct requires a mutable reference
3742
//! but it is also required that this struct has `'static` lifetime bounds itself.
38-
39-
// Copyright 2019 Andreas Molzer
43+
// Copyright 2019,2022 Andreas Molzer
4044
#![no_std]
4145
#![deny(missing_docs)]
4246

0 commit comments

Comments
 (0)