Skip to content

Commit 8522850

Browse files
committed
Updated docs
1 parent 046aa60 commit 8522850

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

docs/platform-specification.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,9 @@ suffixes are `.linux`, `.windows` and `.macosx`.
8383

8484
The following automatically generated properties can be used globally in all configuration files:
8585

86-
- `{runtime.platform.path}`: the absolute path of the [board platform](#platform-terminology) folder (i.e. the folder
87-
containing boards.txt)
86+
- `{runtime.platform.path}`: is the absolute path of the [board platform](#platform-terminology) folder (i.e. the folder
87+
containing boards.txt) unless `{runtime.use_core_platform_path_for_runtime_platform_path}` is set to `true` in this
88+
case, the value is the absolute path of the referenced core platform.
8889
- `{runtime.hardware.path}`: the absolute path of the hardware folder (i.e. the folder containing the
8990
[board platform](#platform-terminology) folder)
9091
- `{runtime.ide.path}`: the absolute path of the Arduino IDE or Arduino CLI folder
@@ -113,8 +114,11 @@ The following automatically generated properties can be used globally in all con
113114
- `{extra.time.zone}`: local timezone offset without the DST component
114115
- `{extra.time.dst}`: local daylight savings time offset
115116

116-
Compatibility note: Versions before Arduino IDE 1.6.0 only used one digit per version number component in
117-
`{runtime.ide.version}` (so 1.5.9 was `159`, not `10509`).
117+
Compatibility notes:
118+
119+
- Versions before Arduino IDE 1.6.0 only used one digit per version number component in `{runtime.ide.version}` (so
120+
1.5.9 was `159`, not `10509`).
121+
- `{runtime.use_core_platform_path_for_runtime_platform_path}` support is available from Arduino CLI >=1.0.4.
118122

119123
## platform.txt
120124

@@ -534,6 +538,9 @@ This explains the presence of **{build.mcu}** or **{build.board}** in the platfo
534538
overwritten respectively by **{uno.build.mcu}** and **{uno.build.board}** when the Uno board is selected! Moreover the
535539
following properties are automatically generated:
536540

541+
- `{build.board.platform.path}`: The path to the selected board's platform.
542+
- `{build.core.platform.path}`: The path to the core's platform. It may differ from the board's platform path because
543+
the latter may reference a core from another platform.
537544
- `{build.core.path}`: The path to the selected board's core folder (inside the [core platform](#platform-terminology),
538545
for example hardware/arduino/avr/core/arduino)
539546
- `{build.system.path}`: The path to the [core platform](#platform-terminology)'s system folder if available (for

0 commit comments

Comments
 (0)