Skip to content

Commit

Permalink
Fix Esp32/Host component titles
Browse files Browse the repository at this point in the history
  • Loading branch information
mikee47 committed Jul 9, 2024
1 parent 7cd912f commit 725549f
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 18 deletions.
14 changes: 3 additions & 11 deletions Sming/Arch/Esp32/Components/heap/README.rst
Original file line number Diff line number Diff line change
@@ -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 <https://www.valgrind.org>`__, this will provide a cleaner trace.
This Component supplments the actual heap implementation provided by the ESP IDF SDK.
2 changes: 1 addition & 1 deletion Sming/Arch/Esp32/Components/spi_flash/README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Esp8266 SPI Flash Support
Esp32 SPI Flash Support
=========================

Provides functions for access to flash memory.
Expand Down
4 changes: 2 additions & 2 deletions Sming/Arch/Host/Components/heap/README.rst
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
4 changes: 2 additions & 2 deletions Sming/Arch/Host/Components/libc/README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
libc
====
Host libc
=========

Contains implementations of any non-standard C library functions.
4 changes: 2 additions & 2 deletions Sming/Arch/Host/Components/spi_flash/README.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 725549f

Please sign in to comment.