Unverified Commit 3d05ade1 authored by per1234's avatar per1234 Committed by GitHub

[skip changelog] Document available memory build properties (#1023)

upload.maximum_data_size and upload.maximum_size are properties used by the build system to fail
compilation when memory usage exceeds a threshold and to calculate the relative memory usage for display in the console.
parent 1ea75180
......@@ -270,6 +270,19 @@ For AVR we have:
recipe.size.regex=^(?:\.text|\.data|\.bootloader)\s+([0-9]+).*
recipe.size.regex.data=^(?:\.data|\.bss|\.noinit)\s+([0-9]+).*
Two properties can be used to define the total available memory:
- `{upload.maximum_size}`: available program storage space
- `{upload.maximum_data_size}`: available dynamic memory for global variables
If the binary sketch size exceeds the value of these properties, the compilation process fails.
This information is displayed in the console output after compiling a sketch, along with the relative memory usage
value:
Sketch uses 924 bytes (2%) of program storage space. Maximum is 32256 bytes.
Global variables use 9 bytes (0%) of dynamic memory, leaving 2039 bytes for local variables. Maximum is 2048 bytes.
#### Recipes to export compiled binary
When you do a **Sketch > Export compiled Binary** in the Arduino IDE, the compiled binary is copied from the build
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment