From 57238aa02cddb20e2fe369e0c7bc56ddd37edefe Mon Sep 17 00:00:00 2001 From: Dan Halbert Date: Fri, 10 Nov 2023 20:25:06 -0500 Subject: [PATCH] Update docs/environment.rst --- docs/environment.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/environment.rst b/docs/environment.rst index c7e05c082d..704c8ebdcf 100644 --- a/docs/environment.rst +++ b/docs/environment.rst @@ -62,10 +62,12 @@ Default BLE name the board advertises as, including for the BLE workflow. CIRCUITPY_HEAP_START_SIZE ~~~~~~~~~~~~~~~~~~~~~~ -Sets the initial size of the python heap. Must be a multiple of 4. The heap will grow by doubling -this initial size until the outer heap cannot fit it. Larger values will reserve more RAM for python -use and prevent the supervisor and SDK from large allocations of their own. Smaller values will -likely grow sooner than large start sizes. +Sets the initial size of the python heap, allocated from the outer heap. Must be a multiple of 4. +The default is currently 8192. +The python heap will grow by doubling and redoubling this initial size until it cannot fit in the outer heap. +Larger values will reserve more RAM for python use and prevent the supervisor and SDK +from large allocations of their own. +Smaller values will likely grow sooner than large start sizes. CIRCUITPY_PYSTACK_SIZE ~~~~~~~~~~~~~~~~~~~~~~