michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc : Corrections to memory_map doc page

Browse source 
Few lines in the doc were out of sync with the code base.

Jira: ZEP-312
Change-Id: Ic0d3508f0f903e43000e17b4a32c1280ae0978dc
Signed-off-by: Jithu Joseph <jithu.joseph@intel.com>
This commit is contained in:
Jithu Joseph 2016-05-25 17:29:03 -07:00 • committed by Anas Nashif
commit a409b3db7a
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/kernel/microkernel/microkernel_memory_maps.rst
View file

@ -116,7 +116,7 @@ when all the memory blocks are in use.
.. code-block:: c .. code-block:: c
char *block_ptr; void *block_ptr;
task_mem_map_alloc(MYMAP, &block_ptr, TICKS_UNLIMITED); task_mem_map_alloc(MYMAP, &block_ptr, TICKS_UNLIMITED);
@ -130,7 +130,7 @@ in the specified time.
.. code-block:: c .. code-block:: c
char *block_ptr; void *block_ptr;
if (task_mem_map_alloc(MYMAP, &block_ptr, 5) == RC_OK)) { if (task_mem_map_alloc(MYMAP, &block_ptr, 5) == RC_OK)) {
/* utilize memory block */ /* utilize memory block */
@ -146,7 +146,7 @@ This code gives an immediate warning when all memory blocks are in use.
.. code-block:: c .. code-block:: c
char *block_ptr; void *block_ptr;
if (task_mem_map_alloc(MYMAP, &block_ptr, TICKS_NONE) == RC_OK) { if (task_mem_map_alloc(MYMAP, &block_ptr, TICKS_NONE) == RC_OK) {
/* utilize memory block */ /* utilize memory block */
@ -162,11 +162,11 @@ This code releases a memory block back when it is no longer needed.
.. code-block:: c .. code-block:: c
char *block_ptr; void *block_ptr;
task_mem_map_alloc(MYMAP, &block_ptr, TICKS_UNLIMITED); task_mem_map_alloc(MYMAP, &block_ptr, TICKS_UNLIMITED);
/* use memory block */ /* use memory block */
task_mem_map_free(&block_ptr); task_mem_map_free(MYMAP, &block_ptr);
APIs APIs