Skip to content

Commit

Permalink
Merge branch 'docs/reorder_mem_alloc_content' into 'master'
Browse files Browse the repository at this point in the history
docs: reorder content in mem_alloc section

See merge request espressif/esp-idf!19920
  • Loading branch information
ESP-Marius committed Sep 5, 2022
2 parents 326b6a9 + 7d629e8 commit f60e940
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions docs/en/api-reference/system/mem_alloc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
--------------------

Expand All @@ -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
Expand Down

0 comments on commit f60e940

Please sign in to comment.