From d68e8e70cf3d55310e8e2db7940b0296519fe3fa Mon Sep 17 00:00:00 2001 From: Zeeshan Ali Khan Date: Wed, 11 Jun 2025 20:46:01 +0200 Subject: [PATCH 1/2] Minor fixes to `pool::boxed` docs --- CHANGELOG.md | 1 + src/pool/boxed.rs | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8c42dd51ec..74834c47ab 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - `bytes::BufMut` is now implemented on `VecInner`. - Removed generic from `history_buf::OldestOrdered`. - Made `LenType` opt-in. +- Minor fixes to `pool::boxed` docs. ### Fixed diff --git a/src/pool/boxed.rs b/src/pool/boxed.rs index 472840fd6f..770ee575b7 100644 --- a/src/pool/boxed.rs +++ b/src/pool/boxed.rs @@ -3,6 +3,7 @@ //! # Example usage //! //! ``` +//! use core::ptr::addr_of_mut; //! use heapless::{box_pool, pool::boxed::{Box, BoxBlock}}; //! //! box_pool!(MyBoxPool: u128); @@ -70,7 +71,7 @@ //! #[allow(clippy::declare_interior_mutable_const)] //! const BLOCK: BoxBlock = BoxBlock::new(); // <= //! static mut BLOCKS: [BoxBlock; POOL_CAPACITY] = [BLOCK; POOL_CAPACITY]; -//! unsafe { addr_of_mut!(BLOCK).as_mut().unwrap()S } +//! unsafe { addr_of_mut!(BLOCKS).as_mut().unwrap() } //! }; //! //! for block in blocks { From 2be25c1e039e2f057d3f7624ff317ddd9d3bd2e0 Mon Sep 17 00:00:00 2001 From: Zeeshan Ali Khan Date: Wed, 11 Jun 2025 22:07:45 +0200 Subject: [PATCH 2/2] Update pool docs 64-bit pools are supported since #458. --- src/pool.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pool.rs b/src/pool.rs index 13f29eebea..d4b94e110b 100644 --- a/src/pool.rs +++ b/src/pool.rs @@ -6,7 +6,7 @@ //! //! - ARM architectures which instruction set include the LDREX, CLREX and STREX instructions, e.g. //! `thumbv7m-none-eabi` but not `thumbv6m-none-eabi` -//! - 32-bit x86, e.g. `i686-unknown-linux-gnu` +//! - 32-bit and 64-bit x86. //! //! # Benchmarks //!