Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 693a045

Browse filesBrowse files
per1234per1234
authored
[skip changelog] Completely document resources not inherited from referenced platform (#940)
The inherited resources resulting from a core reference are clearly documented. However, the variant reference mentioned the non-inheritance of platform.txt properties alone. For me, this left it unclear whether the lack of mention of the other resources implied that variant and tool references resulted in their inheritance, and that it was only considered necessary to document it once in the platform reference documentation. One option for resolving this would be to remove the statement that caused the confusion. However, since this is a complex subject, I thought it better to just explicitly document the non-inheritance of the resources in both the variant and tools reference sections of the documentation to make it completely clear.
1 parent f1877ef commit 693a045
Copy full SHA for 693a045

File tree

Expand file treeCollapse file tree

1 file changed

+5
-2
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+5
-2
lines changed

‎docs/platform-specification.md

Copy file name to clipboardExpand all lines: docs/platform-specification.md
+5-2Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -927,8 +927,8 @@ In the same way we can use a variant defined on another platform using the synta
927927
myboard.build.variant=arduino:standard
928928
[....]
929929

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

933933
### Tool references
934934

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

943+
Note that, unlike core references, referencing a tool recipe does _not_ result in any other resources being inherited
944+
from the referenced platform.
945+
943946
### Platform Terminology
944947

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

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.