From 725549febe781321649bcbe4d25aca0dae1fb3b3 Mon Sep 17 00:00:00 2001 From: mikee47 Date: Tue, 9 Jul 2024 21:08:39 +0100 Subject: [PATCH] Fix Esp32/Host component titles --- Sming/Arch/Esp32/Components/heap/README.rst | 14 +++----------- Sming/Arch/Esp32/Components/spi_flash/README.rst | 2 +- Sming/Arch/Host/Components/heap/README.rst | 4 ++-- Sming/Arch/Host/Components/libc/README.rst | 4 ++-- Sming/Arch/Host/Components/spi_flash/README.rst | 4 ++-- 5 files changed, 10 insertions(+), 18 deletions(-) diff --git a/Sming/Arch/Esp32/Components/heap/README.rst b/Sming/Arch/Esp32/Components/heap/README.rst index a8ea0dac75..fc5c68bc47 100644 --- a/Sming/Arch/Esp32/Components/heap/README.rst +++ b/Sming/Arch/Esp32/Components/heap/README.rst @@ -1,12 +1,4 @@ -Heap -==== +Esp32 Heap +========== -This Component implements heap-related housekeeping functions. Heap usage is tracked using :component:`malloc_count`. -This also provides some validation (using *sentinels* to detect if memory blocks are overwritten). - -.. envvar:: ENABLE_MALLOC_COUNT - - We require :component:`malloc_count` to keep track of heap usage for system_get_free_heap_size(). - It does this by hooking the memory allocation routines (malloc, free, etc.). - If you wish to disable this behaviour, set `ENABLE_MALLOC_COUNT=0`. - If using tools such as `Valgrind `__, this will provide a cleaner trace. +This Component supplments the actual heap implementation provided by the ESP IDF SDK. diff --git a/Sming/Arch/Esp32/Components/spi_flash/README.rst b/Sming/Arch/Esp32/Components/spi_flash/README.rst index 31b49e646b..56e9495129 100644 --- a/Sming/Arch/Esp32/Components/spi_flash/README.rst +++ b/Sming/Arch/Esp32/Components/spi_flash/README.rst @@ -1,4 +1,4 @@ -Esp8266 SPI Flash Support +Esp32 SPI Flash Support ========================= Provides functions for access to flash memory. diff --git a/Sming/Arch/Host/Components/heap/README.rst b/Sming/Arch/Host/Components/heap/README.rst index a8ea0dac75..83a292391e 100644 --- a/Sming/Arch/Host/Components/heap/README.rst +++ b/Sming/Arch/Host/Components/heap/README.rst @@ -1,5 +1,5 @@ -Heap -==== +Host Heap support +================= This Component implements heap-related housekeeping functions. Heap usage is tracked using :component:`malloc_count`. This also provides some validation (using *sentinels* to detect if memory blocks are overwritten). diff --git a/Sming/Arch/Host/Components/libc/README.rst b/Sming/Arch/Host/Components/libc/README.rst index 57bd3a21eb..7d28c40fb7 100644 --- a/Sming/Arch/Host/Components/libc/README.rst +++ b/Sming/Arch/Host/Components/libc/README.rst @@ -1,4 +1,4 @@ -libc -==== +Host libc +========= Contains implementations of any non-standard C library functions. diff --git a/Sming/Arch/Host/Components/spi_flash/README.rst b/Sming/Arch/Host/Components/spi_flash/README.rst index 4a427923ed..83047814a1 100644 --- a/Sming/Arch/Host/Components/spi_flash/README.rst +++ b/Sming/Arch/Host/Components/spi_flash/README.rst @@ -1,5 +1,5 @@ -SPI Flash -========= +SPI Flash Emulation +=================== This Component emulates an embedded flash memory device using a backing file. It includes additional checks on addresses, sizes and alignments to detect common issues which can be more difficult to find