Skip to content
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

[skip changelog] Document platform bundled libraries #872

Merged
merged 1 commit into from
Jul 28, 2020
Merged

[skip changelog] Document platform bundled libraries #872

merged 1 commit into from
Jul 28, 2020

Conversation

per1234
Copy link
Contributor

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

Bundled libraries are a very important component of most Arduino platforms, but this capability only has a brief mention in https://arduino.github.io/arduino-cli/dev/platform-specification/#referencing-another-core-variant-or-tool and https://arduino.github.io/arduino-cli/dev/sketch-build-process/#location-priority, with no explanation of what they are or how they are used.

Even fairly advanced Arduino users are often confused by the fact that Arduino libraries are stored in multiple locations.

  • What is the new behavior?

Platform bundled libraries are documented in the Arduino platform specification.

  • Does this PR introduce a breaking change?

No.

@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 27, 2020
@per1234 per1234 merged commit 17299a0 into arduino:master Jul 28, 2020
@per1234 per1234 deleted the platform-bundled-libraries branch July 28, 2020 09:45
@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