alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'docs/reorder_mem_alloc_content_v4.4' into 'release/v4.4'

Browse Source 
docs: reorder content in mem_alloc section (v4.4)

See merge request espressif/esp-idf!19949
This commit is contained in:
morris 2022-09-05 16:04:30 +08:00
commit a825bfdebb
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/en/api-reference/system/mem_alloc.rst
View File

@ -121,14 +121,8 @@ generate a fatal LoadStoreError exception.
To use the region above the 4MiB limit, you can use the :doc:`himem API</api-reference/system/himem>`.
API Reference - Heap Allocation
-------------------------------
.. include-build-file:: inc/esp_heap_caps.inc
Thread Safety
^^^^^^^^^^^^^
-------------
Heap functions are thread safe, meaning they can be called from different tasks simultaneously without any limitations.
@ -143,11 +137,6 @@ The following features are documented on the :doc:`Heap Memory Debugging </api-r
- :ref:`Heap Corruption Detection <heap-corruption>`
- :ref:`Heap Tracing <heap-tracing>` (memory leak detection, monitoring, etc.)
API Reference - Initialisation
------------------------------
.. include-build-file:: inc/esp_heap_caps_init.inc
Implementation Notes
--------------------
@ -159,6 +148,18 @@ The heap capabilities allocator uses knowledge of the memory regions to initiali
Calling ``free()`` involves finding the particular heap corresponding to the freed address, and then calling :cpp:func:`multi_heap_free` on that particular multi_heap instance.
API Reference - Heap Allocation
-------------------------------
.. include-build-file:: inc/esp_heap_caps.inc
API Reference - Initialisation
------------------------------
.. include-build-file:: inc/esp_heap_caps_init.inc
.. _multi-heap:
API Reference - Multi Heap API