From ed4763c7142e786dd03beaff450a2d8be1625e6c Mon Sep 17 00:00:00 2001 From: Sean Cross Date: Wed, 15 Jun 2022 12:35:05 +0800 Subject: [PATCH] xous: correct comments on IncreaseHeap and DecreaseHeap These were behaving differently from what they were documented to do. Signed-off-by: Sean Cross --- xous-rs/src/syscall.rs | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/xous-rs/src/syscall.rs b/xous-rs/src/syscall.rs index 3938e7e68..6735f61e9 100644 --- a/xous-rs/src/syscall.rs +++ b/xous-rs/src/syscall.rs @@ -72,12 +72,14 @@ pub enum SysCall { /// Add the given number of bytes to the heap. The number of bytes must be /// divisible by the page size. The newly-allocated pages will have the /// specified flags. To get the current heap base, call this with a size of - /// `0`. + /// `0`, which will return a `MemoryRange` containing the heap base and the size. /// /// # Returns /// - /// * **MemoryRange(*mut usize /* The base of the heap */, usize /* the new - /// size of the heap */) + /// * **MemoryRange( + /// *mut usize, /* The newly-allocated offset */ + /// usize, /* The amount of data added */ + /// )** /// /// # Errors ///