From 7d629e8c84abb4afc439a0fd4d46a73bf9a637b5 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Fri, 2 Sep 2022 14:29:51 +0800 Subject: [PATCH] docs: reorder content in mem_alloc section We should avoid hiding sections between long lists of API documentation. --- docs/en/api-reference/system/mem_alloc.rst | 25 +++++++++++----------- 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/en/api-reference/system/mem_alloc.rst b/docs/en/api-reference/system/mem_alloc.rst index 6660b22df4..86d2c3267b 100644 --- a/docs/en/api-reference/system/mem_alloc.rst +++ b/docs/en/api-reference/system/mem_alloc.rst @@ -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 - 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 ` - :ref:`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