From 4ea92d1ed11f0fc93d6b40729ebe7ec5c03d448e Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Fri, 27 Jan 2017 08:06:06 +0100 Subject: score: Clarify _Heap_Extend() Update #1747. --- cpukit/score/include/rtems/score/heap.h | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'cpukit/score/include/rtems/score/heap.h') diff --git a/cpukit/score/include/rtems/score/heap.h b/cpukit/score/include/rtems/score/heap.h index 3835e7de41..f2a0fb73d7 100644 --- a/cpukit/score/include/rtems/score/heap.h +++ b/cpukit/score/include/rtems/score/heap.h @@ -413,11 +413,12 @@ typedef uintptr_t (*Heap_Initialization_or_extend_handler)( * @brief Extends the memory available for the heap @a heap using the memory * area starting at @a area_begin of size @a area_size bytes. * - * There are no alignment requirements. The memory area must be big enough to - * contain some maintenance blocks. It must not overlap parts of the current - * heap areas. Disconnected subordinate heap areas will lead to used blocks - * which cover the gaps. Extending with an inappropriate memory area will - * corrupt the heap. + * There are no alignment requirements for the memory area. The memory area + * must be big enough to contain some maintenance blocks. It must not overlap + * parts of the current heap memory areas. Disconnected memory areas added to + * the heap will lead to used blocks which cover the gaps. Extending with an + * inappropriate memory area will corrupt the heap resulting in undefined + * behaviour. * * The unused fourth parameter is provided to have the same signature as * _Heap_Initialize(). -- cgit v1.2.3