Module: xenomai-3
Branch: next
Commit: f55a04258bb4e762df3871820541610b817db5de
URL:    
http://git.xenomai.org/?p=xenomai-3.git;a=commit;h=f55a04258bb4e762df3871820541610b817db5de

Author: Philippe Gerum <r...@xenomai.org>
Date:   Fri Jun 19 15:56:34 2015 +0200

alchemy/heap: clarify documentation of RT_HEAP_INFO

---

 include/alchemy/heap.h |    8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/include/alchemy/heap.h b/include/alchemy/heap.h
index 998cb8c..ade2f47 100644
--- a/include/alchemy/heap.h
+++ b/include/alchemy/heap.h
@@ -55,7 +55,9 @@ struct RT_HEAP_INFO {
         */
        int mode;
        /**
-        * Overall size of heap (in bytes).
+        * Size of heap (in bytes) as given to rt_heap_create(). The
+        * maximum amount of memory available from this heap may be
+        * larger, due to internal padding.
         */
        size_t heapsize;
        /**
@@ -65,7 +67,9 @@ struct RT_HEAP_INFO {
         */
        size_t usablemem;
        /**
-        * Amount of heap memory currently consumed.
+        * Amount of heap memory currently consumed. info.usablemem -
+        * info.usedmem computes the current amount of free memory in
+        * the relevant heap.
         */
        size_t usedmem;
        /**


_______________________________________________
Xenomai-git mailing list
Xenomai-git@xenomai.org
http://xenomai.org/mailman/listinfo/xenomai-git

Reply via email to