Skip to content

[skip changelog] Completely document resources not inherited from referenced platform #940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 10, 2020
Merged

[skip changelog] Completely document resources not inherited from referenced platform #940

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/platform-specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -927,8 +927,8 @@ In the same way we can use a variant defined on another platform using the synta
myboard.build.variant=arduino:standard
[....]

Note that referencing a variant in another platform does _not_ inherit any properties from that platform's platform.txt
(like referencing a core does).
Note that, unlike core references, other resources (platform.txt, bundled libraries, programmers) are _not_ inherited
from the referenced platform.

### Tool references

Expand All @@ -940,6 +940,9 @@ Tool recipes defined in the platform.txt of other platforms can also be referenc
myboard.bootloader.tool=arduino:avrdude
[....]

Note that, unlike core references, referencing a tool recipe does _not_ result in any other resources being inherited
from the referenced platform.

### Platform Terminology

Because boards can reference cores, variants and tools in different platforms, this means that a single build or upload
Expand Down