mirror of
https://github.com/saymrwulf/xous-core.git
synced 2026-11-18 08:52:45 +00:00
xous: correct comments on IncreaseHeap and DecreaseHeap
These were behaving differently from what they were documented to do. Signed-off-by: Sean Cross <sean@xobs.io>
This commit is contained in:
parent
b31c727f81
commit
ed4763c714
1 changed files with 5 additions and 3 deletions
|
|
@ -72,12 +72,14 @@ pub enum SysCall {
|
||||||
/// Add the given number of bytes to the heap. The number of bytes must be
|
/// 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
|
/// 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
|
/// 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
|
/// # Returns
|
||||||
///
|
///
|
||||||
/// * **MemoryRange(*mut usize /* The base of the heap */, usize /* the new
|
/// * **MemoryRange(
|
||||||
/// size of the heap */)
|
/// *mut usize, /* The newly-allocated offset */
|
||||||
|
/// usize, /* The amount of data added */
|
||||||
|
/// )**
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue