Skip to content

[skip changelog] Document the boards.txt vid and pid properties #812

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
Jul 23, 2020
Merged

[skip changelog] Document the boards.txt vid and pid properties #812

merged 1 commit into from
Jul 23, 2020

Conversation

per1234
Copy link
Contributor

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

Documentation update.

  • What is the current behavior?

The boards.txt vid and pid properties are not documented. These properties are becoming increasingly important as the modern Arduino development software takes advantage of them for features based on automatic board detection (e.g., Arduino Web Editor's automatic board selection, arduino-cli board attach <port>)

  • What is the new behavior?

The vid and pid properties of boards.txt are documented in the platform specification.

  • Does this PR introduce a breaking change?

No.

@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 9, 2020
@rsora rsora merged commit b2378e7 into arduino:master Jul 23, 2020
@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