Merge branch 'rust-embedded:master' into allocator_api

Author: rmja

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: nightly
+          toolchain: stable
           target: ${{ matrix.target }}
           override: true
       - uses: actions-rs/cargo@v1

.github/workflows/clippy.yml

@@ -18,7 +18,7 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: nightly
+          toolchain: stable
           override: true
           components: clippy
       - uses: actions-rs/clippy-check@v1

.github/workflows/cron.yml

@@ -13,7 +13,7 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: nightly
+          toolchain: stable
           target: thumbv6m-none-eabi
           override: true
       - uses: actions-rs/cargo@v1

.github/workflows/rustfmt.yml

@@ -13,7 +13,7 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: nightly
+          toolchain: stable
           override: true
           components: rustfmt
       - uses: actions-rs/cargo@v1

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+- Updated `linked_list_allocator` dependency to 0.10.5, which allows
+  compiling with stable rust.
+
 ## [v0.5.0] - 2022-12-06
 
 ### Changed

Cargo.toml

@@ -31,7 +31,7 @@ critical-section = "1.0"
 
 [dependencies.linked_list_allocator]
 default-features = false
-version = "0.10.4"
+version = "0.10.5"
 features = ["const_mut_refs"]
 
 [dev-dependencies]

README.md

@@ -1,21 +1,50 @@
 [![crates.io](https://img.shields.io/crates/d/embedded-alloc.svg)](https://crates.io/crates/embedded-alloc)
 [![crates.io](https://img.shields.io/crates/v/embedded-alloc.svg)](https://crates.io/crates/embedded-alloc)
+![Minimum Supported Rust Version](https://img.shields.io/badge/rustc-1.68+-blue.svg) -
+ [Documentation](https://docs.rs/embedded-alloc) - [Change log](https://github.com/rust-embedded/embedded-alloc/blob/master/CHANGELOG.md)
 
 # `embedded-alloc`
 
 > A heap allocator for embedded systems.
 
-Note that using this as your global allocator requires nightly Rust.
+Note that using this as your global allocator requires Rust 1.68 or later.
+(With earlier versions, you need the unstable feature `#![feature(default_alloc_error_handler)]`)
 
 This project is developed and maintained by the [Cortex-M team][team].
 
 ## Example
 
-For a usage example, see `examples/global_alloc.rs`.
+Starting with Rust 1.68, this crate can be used as a global allocator on stable Rust:
 
-## [Documentation](https://docs.rs/embedded-alloc)
+```rust
+#![no_std]
+#![no_main]
 
-## [Change log](CHANGELOG.md)
+extern crate alloc;
+
+use cortex_m_rt::entry;
+use embedded_alloc::Heap;
+
+#[global_allocator]
+static HEAP: Heap = Heap::empty();
+
+#[entry]
+fn main() -> ! {
+    // Initialize the allocator BEFORE you use it
+    {
+        use core::mem::MaybeUninit;
+        const HEAP_SIZE: usize = 1024;
+        static mut HEAP_MEM: [MaybeUninit<u8>; HEAP_SIZE] = [MaybeUninit::uninit(); HEAP_SIZE];
+        unsafe { HEAP.init(HEAP_MEM.as_ptr() as usize, HEAP_SIZE) }
+    }
+
+    // now the allocator is ready types like Box, Vec can be used.
+
+    loop { /* .. */ }
+}
+```
+
+For a full usage example, see [`examples/global_alloc.rs`](https://github.com/rust-embedded/embedded-alloc/blob/master/examples/global_alloc.rs).
 
 ## License
 

examples/global_alloc.rs

@@ -1,11 +1,9 @@
 #![no_std]
 #![no_main]
-#![feature(alloc_error_handler)]
 
 extern crate alloc;
 
 use alloc::vec::Vec;
-use core::alloc::Layout;
 use core::panic::PanicInfo;
 use cortex_m_rt::entry;
 use embedded_alloc::Heap;
@@ -29,11 +27,6 @@ fn main() -> ! {
     loop { /* .. */ }
 }
 
-#[alloc_error_handler]
-fn oom(_: Layout) -> ! {
-    loop {}
-}
-
 #[panic_handler]
 fn panic(_: &PanicInfo) -> ! {
     loop {}