Merge pull request #27 from aliciawyy/wipDoc

Improve clarity of alloc_aligned doc
rcore-os · Jul 18, 2023 · a5136d6 · a5136d6
2 parents 60f356e + ac6023f
commit a5136d6
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/frame.rs b/src/frame.rs
@@ -89,6 +89,8 @@ impl<const ORDER: usize> FrameAllocator<ORDER> {
 
     /// Allocate a range of frames with the given size and alignment from the allocator, returning
     /// the first frame of the allocated range.
+    /// The allocated size is the maximum of the next power of two of the given size and the
+    /// alignment.
     pub fn alloc_aligned(&mut self, layout: Layout) -> Option<usize> {
         let size = max(layout.size().next_power_of_two(), layout.align());
         self.alloc_power_of_two(size)