2011-02-17 Sebastian Huber <sebastian.huber@embedded-brains.de>

	* libcsupport/src/rtems_heap_extend.c: New file.
	* libcsupport/Makefile.am: Reflect change from above.
	* libcsupport/include/rtems/malloc.h: Declare rtems_heap_extend().
	* score/include/rtems/score/heap.h: Documentation.

1 files changed, 7 insertions, 5 deletions

diff --git a/cpukit/score/include/rtems/score/heap.h b/cpukit/score/include/rtems/score/heap.h
index 96eaea5a61..6eee1c745b 100644
--- a/cpukit/score/include/rtems/score/heap.h
+++ b/cpukit/score/include/rtems/score/heap.h
@@ -430,15 +430,17 @@ uintptr_t _Heap_Initialize(
 );
 
 /**
- * @brief Extends the memory area of the heap @a heap using the memory area
- * starting at @a area_begin of size @a area_size bytes.
+ * @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.
  *
  * The extended space available for allocation will be returned in
  * @a amount_extended.  This pointer may be @c NULL.
  *
- * The memory area must be big enough to contain some maintainance blocks.  It
- * must not overlap parts of the current heap areas.  Disconnected subordinate
- * heap areas will lead to used blocks which cover the gaps. 
+ * There are no alignment requirements.  The memory area must be big enough to
+ * contain some maintainance 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.
  *
  * Returns @c true in case of success, and @c false otherwise.
  */