Skip to content

Commit c5af86f

Browse files
committed
document --min-free-space option
1 parent fae2591 commit c5af86f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Diff for: REFERENCE.md

+5
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@ This allows a file (or glob) pattern to be executed in your tests directory, cre
4444
This allows a file (or glob) pattern to be executed in your tests directory, creating a blacklist of files to skip. E.g. `--testfile-reject=test_animal_*.cpp` would match `test_animal_cat.cpp` and `test_animal_dog.cpp` (skipping those) and test only `test_plant_rose.cpp`, `test_plant_daisy.cpp`, etc.
4545

4646

47+
### `--min-free-space` option
48+
49+
This specifies the minimum free SRAM memory for stack/heap, in bytes, that _must_ be leftover after compilation. This value applies globally -- to _all_ platforms that will be included in a test run.
50+
51+
4752
### `CUSTOM_INIT_SCRIPT` environment variable
4853

4954
If set, testing will execute (using `/bin/sh`) the script referred to by this variable -- relative to the current working directory (i.e. the root directory of the library). The script will _run_ in the Arduino Libraries directory (changing to the Libraries directory, running the script, and returning to the individual library root afterward). This enables use cases like the GitHub action to install custom library versions (i.e. a version of a library that is different than what the library manager would automatically install by name) prior to CI test runs.

0 commit comments

Comments
 (0)