Skip to content

Commit 3e6456d

Browse files
committed
Document CIRCUITPY_HEAP_START_SIZE
and remove CIRCUITPY_RESERVED_PSRAM. Fixes #8581
1 parent d410efd commit 3e6456d

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/environment.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,18 +60,19 @@ CIRCUITPY_BLE_NAME
6060
~~~~~~~~~~~~~~~~~~
6161
Default BLE name the board advertises as, including for the BLE workflow.
6262

63+
CIRCUITPY_HEAP_START_SIZE
64+
~~~~~~~~~~~~~~~~~~~~~~
65+
Sets the initial size of the python heap. Must be a multiple of 4. The heap will grow by doubling
66+
this initial size until the outer heap cannot fit it. Larger values will reserve more RAM for python
67+
use and prevent the supervisor and SDK from large allocations of their own. Smaller values will
68+
likely grow sooner than large start sizes.
69+
6370
CIRCUITPY_PYSTACK_SIZE
6471
~~~~~~~~~~~~~~~~~~~~~~
6572
Sets the size of the python stack. Must be a multiple of 4. The default value is currently 1536.
6673
Increasing the stack reduces the size of the heap available to python code.
6774
Used to avoid "Pystack exhausted" errors when the code can't be reworked to avoid it.
6875

69-
CIRCUITPY_RESERVED_PSRAM
70-
~~~~~~~~~~~~~~~~~~~~~~~~
71-
On boards with Espressif microcontrollers with PSRAM (also called SPIRAM), permanently reserve a portion of PSRAM for use by esp-idf.
72-
This storage is removed from the CircuitPython "heap" and is available for allocation by esp-idf routines in the core instead.
73-
Generally, only set this to a non-zero value when it is required by a specific core module.
74-
7576
CIRCUITPY_WEB_API_PASSWORD
7677
~~~~~~~~~~~~~~~~~~~~~~~~~~
7778
Password required to make modifications to the board from the Web Workflow.

0 commit comments

Comments
 (0)