Skip to content

[skip changelog] Document ability to override properties of referenced tools #963

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.

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 22, 2020
Merged

[skip changelog] Document ability to override properties of referenced tools #963

merged 1 commit into from
Sep 22, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Sep 22, 2020

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce?
  • What is the current behavior?

Arduino CLI (and thus Arduino Pro IDE as well) provides the very interesting capability to modify referenced tool recipes via overrides in the referencing platform's platform.txt but this is undocumented.

The equivalent capabilty is mentioned in the core reference documentation, so the lack of mention of it in the tools referencing section could be seen as implying that it's not supported.

Overrides don't apply to referenced variants, so this is not a universal capability that can be documented in the general purpose referencing documentation.

  • What is the new behavior?

The ability to override properties used in referenced tool recipes from the platform.txt of the referencing platform is documented in the platform specification.

  • Does this PR introduce a breaking change?

No

  • Other information:

Arduino IDE does not currently provide this capability.

…d tools

Arduino CLI provides the very interesting capability to modify referenced tool recipes via overrides in the referencing platform's platform.txt.

Arduino IDE does not currently provide this capability.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Sep 22, 2020
@per1234 per1234 merged commit be39aa9 into arduino:master Sep 22, 2020
@per1234 per1234 deleted the document-tool-reference-property-override branch September 22, 2020 11:10
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants