[rtems commit] score: Clarify _Heap_Extend()

[Sebastian Huber]

Module:    rtems
Branch:    master
Commit:    4ea92d1ed11f0fc93d6b40729ebe7ec5c03d448e
Changeset: http://git.rtems.org/rtems/commit/?id=4ea92d1ed11f0fc93d6b40729ebe7ec5c03d448e

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Fri Jan 27 08:06:06 2017 +0100

score: Clarify _Heap_Extend()

Update #1747.

---

 cpukit/score/include/rtems/score/heap.h | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/cpukit/score/include/rtems/score/heap.h b/cpukit/score/include/rtems/score/heap.h
index 3835e7d..f2a0fb7 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().