Skip to content

Commit eef3705

Browse files
authored
[skip changelog] Document build.library_discovery_phase property in platform specification (#868)
1 parent 55859ad commit eef3705

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/platform-specification.md

+6
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,12 @@ The following automatically generated properties can be used globally in all con
9191
`VENDOR:ARCHITECTURE:BOARD_ID[:MENU_ID=OPTION_ID[,MENU2_ID=OPTION_ID ...]]`
9292
- `{build.source.path}`: Path to the sketch being compiled. If the sketch is in an unsaved state, it will the path of
9393
its temporary folder.
94+
- `{build.library_discovery_phase}`: set to 1 during library discovery and to 0 during normal build. A macro defined
95+
with this property can be used to disable the inclusion of heavyweight headers during discovery to reduce compilation
96+
time. This property was added in Arduino IDE 1.8.14/Arduino Builder 1.6.0/Arduino CLI 0.12.0. Note: with the same
97+
intent, `-DARDUINO_LIB_DISCOVERY_PHASE` was added to `recipe.preproc.macros` during library discovery in Arduino
98+
Builder 1.5.3/Arduino CLI 0.10.0. That flag was replaced by the more flexible `{build.library_discovery_phase}`
99+
property.
94100
- `{extra.time.utc}`: Unix time (seconds since 1970-01-01T00:00:00Z) according to the machine the build is running on
95101
- `{extra.time.local}`: Unix time with local timezone and DST offset
96102
- `{extra.time.zone}`: local timezone offset without the DST component

0 commit comments

Comments
 (0)