docs: GlobalAlloc: Make example only require 4096-aligned static

Alignments > 4k are not supported, rust-lang#70022 rust-lang#70144 Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
ijackson · Jul 21, 2021 · 03d7001 · 03d7001
1 parent 07e11e8
commit 03d7001
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/library/core/src/alloc/global.rs b/library/core/src/alloc/global.rs
@@ -30,7 +30,8 @@ use crate::ptr;
 /// };
 ///
 /// const ARENA_SIZE: usize = 128 * 1024;
-/// #[repr(C, align(131072))] // 131072 == ARENA_SIZE.
+/// const MAX_SUPPORTED_ALIGN: usize = 4096;
+/// #[repr(C, align(4096))] // 4096 == MAX_SUPPORTED_ALIGN
 /// struct SimpleAllocator {
 ///     arena: UnsafeCell<[u8; ARENA_SIZE]>,
 ///     remaining: AtomicUsize, // we allocate from the top, counting down
@@ -53,8 +54,7 @@ use crate::ptr;
 ///         // So we can safely use a mask to ensure alignment without worrying about UB.
 ///         let align_mask_to_round_down = !(align - 1);
 ///
-///         if align > ARENA_SIZE {
-///             // align may be > size !
+///         if align > MAX_SUPPORTED_ALIGN {
 ///             return null_mut();
 ///         }
 ///