mynewt-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ad...@apache.org
Subject [06/15] incubator-mynewt-site git commit: Updated memory pool function list to table with descriptions.
Date Thu, 23 Jun 2016 21:19:17 GMT
Updated memory pool function list to table with descriptions.


Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/798d2823
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/798d2823
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/798d2823

Branch: refs/heads/develop
Commit: 798d2823efab267166406c49c4d5ee8b10ebc9ff
Parents: ac49f1c
Author: = <=>
Authored: Thu Jun 23 09:24:02 2016 -0700
Committer: = <=>
Committed: Thu Jun 23 09:24:02 2016 -0700

----------------------------------------------------------------------
 docs/os/core_os/memory_pool/memory_pool.md | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/798d2823/docs/os/core_os/memory_pool/memory_pool.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/memory_pool/memory_pool.md b/docs/os/core_os/memory_pool/memory_pool.md
index 19aca55..7009920 100644
--- a/docs/os/core_os/memory_pool/memory_pool.md
+++ b/docs/os/core_os/memory_pool/memory_pool.md
@@ -61,14 +61,16 @@ struct os_mempool {
 | name | Name for the memory block |
   
   
-### List of Functions
+### List of Functions/Macros
 
-The functions available in mem_pool are:
+The functions/macros available in mem_pool are:
 
-* [os_memblock_get](os_memblock_get)
-* [os_mempool_init](os_mempool_init)
-* [os_memblock_put](os_memblock_put)
-* [OS_MEMPOOL_BYTES](OS_MEMPOOL_BYTES)
-* [OS_MEMPOOL_SIZE](OS_MEMPOOL_SIZE)
+| **Function** | **Description** |
+|-----------|-------------|
+| [os_memblock_get](os_memblock_get) | Allocate an element from the memory pool. |
+| [os_mempool_init](os_mempool_init) | Initializes the memory pool. |
+| [os_memblock_put](os_memblock_put) | Releases previously allocated element back to the
pool. |
+| [OS_MEMPOOL_BYTES](OS_MEMPOOL_BYTES) | Calculates how many bytes of memory is used by n
number of elements, when individual element size is blksize bytes. |
+| [OS_MEMPOOL_SIZE](OS_MEMPOOL_SIZE) | Calculates the number of os_membuf_t elements used
by n blocks of size blksize bytes. |
 
 


Mime
View raw message