Skip to content

Commit 7e734df

Browse files
authored
Merge pull request #7951 from Neradoc/pystack-doc-and-size
Document CIRCUITPY_PYSTACK_SIZE
2 parents f8cbdf8 + bb2af51 commit 7e734df

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/environment.rst

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

63+
CIRCUITPY_PYSTACK_SIZE
64+
~~~~~~~~~~~~~~~~~~~~~~
65+
Sets the size of the python stack. Must be a multiple of 4. The default value is currently 1536.
66+
Increasing the stack reduces the size of the heap available to python code.
67+
Used to avoid "Pystack exhausted" errors when the code can't be reworked to avoid it.
68+
6369
CIRCUITPY_RESERVED_PSRAM
6470
~~~~~~~~~~~~~~~~~~~~~~~~
6571
On boards with Espressif microcontrollers with PSRAM (also called SPIRAM), permanently reserve a portion of PSRAM for use by esp-idf.

0 commit comments

Comments
 (0)