Skip to content

[skip changelog] Document that use of auto-set build.board property results in warning #817

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

Jump to bottom
Merged
merged 1 commit into from
Jul 23, 2020
Merged

[skip changelog] Document that use of auto-set build.board property results in warning #817

merged 1 commit into from
Jul 23, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jul 10, 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?

Docs update

  • What is the current behavior?

Documentation of the auto-set property makes it sound like a convenience feature, with the build.board property only needed if you prefer a custom value for some reason. However, the resulting warning (Warning: Board foo:bar:baz doesn't define a 'build.board' preference. Auto-set to: BAR_BAZ) can cause confusion and act as a "red herring" for users of board definitions that don't define a build.board property.

  • What is the new behavior?

The platform specification mentions that not defining a build.board property results in a warning.

  • Does this PR introduce a breaking change?

No

@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 10, 2020
@per1234
Document that use of auto-set build.board property results in warning
8ba2f16 
The previous description made it sound like a convenience feature, with the build.board property only needed if you prefer a custom value for some reason. However, the resulting warning can cause confusion and act as a "red herring" for users of board definitions that don't define a build.board property.
@rsora rsora merged commit 35fb9ed into arduino:master Jul 23, 2020
@per1234 per1234 deleted the auto-board-identifier-warning branch July 23, 2020 12:46
@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
Reviewers

@rsora rsora rsora approved these changes

Assignees

@per1234 per1234

Labels
topic: documentation Related to documentation for the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@per1234 @rsora