Skip to content

[skip changelog] Update outdated information in platform specification #787

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 4 commits into from
Jul 6, 2020
Merged

[skip changelog] Update outdated information in platform specification #787

merged 4 commits into from
Jul 6, 2020

Conversation

per1234
Copy link
Contributor

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

The platform specification contains some outdated information regarding:

  • Prevalence of usb to serial chip on Arduino boards
    • It's no longer true (and becoming increasingly less so) that "most" Arduino boards have a dedicated USB to serial chip.
  • Sketch size regular expression properties
    • No documentation of recipe.size.regex.data
    • Outdated recipe.size.regex value for Arduino AVR Boards
  • platform.local.txt location
    • The documented location only applies to the structure of manual platform installations
  • Upload tools used by Arduino platforms
  • What is the new behavior?

Information in platform specification is updated.

  • Does this PR introduce a breaking change?

No

per1234 added 4 commits July 4, 2020 23:53
…duino boards

It's no longer true that "most" Arduino boards have a dedicated USB to serial chip (and becoming increasingly less so).
The platform specification was outdated in regard to the sketch size determination regular expression properties.

- Document recipe.size.regex.data
- Update Arduino AVR Boards' recipe.size.regex value
Previously, the location specified by the platform specification applied only to the folder structure of manually installed platforms. When a platform is installed via Boards Manager, there is an additional version folder level and it is under this folder the platform.local.txt must be placed.

The documentation now applies equally well to either platform installation type.
The statement was written at a time when there was only two Arduino platforms. Although still correct, it had a decidedly outdated feel that was fixed by a minor rewording.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 5, 2020
@rsora rsora requested a review from cmaglie July 6, 2020 14:12
@per1234 per1234 merged commit e5924c9 into arduino:master Jul 6, 2020
@per1234 per1234 deleted the update-platform-specification branch July 8, 2020 21:19
@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