Skip to content

[skip changelog] Document library location priorities in Arduino Web Editor #979

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

[skip changelog] Document library location priorities in Arduino Web Editor #979

merged 1 commit into from
Sep 25, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Sep 24, 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?

Although Arduino Web Editor uses the same build system as the other Arduino development software, the cloud-based nature can make it more difficult to determine library locations.

Although very convenient, Arduino Web Editor having every one of the thousands of Library Manager libraries pre-installed does result in a higher incidence of header filename collisions. This means it is especially important for Arduino Web Editor users to understand library location priorities. However, the sketch build process documentation's "Location priority" section doesn't provide any Arduino Web Editor-specific information.

  • What is the new behavior?

Library location priorities in Arduino Web Editor are fully documented.

  • Does this PR introduce a breaking change?

No

  • Other information:

The -libraries options passed to arduino-builder by Arduino Web Editor are in this order:

-libraries /tmp/803503227/custom -libraries /tmp/803503227/pinned

This order causes the "custom" libraries to have a higher location priority than the "pinned" libraries.

…Editor

Although Arduino Web Editor uses the same build system as the other Arduino development software, the
cloud-based nature can make it more difficult to determine library locations.

Although very convenient, Arduino Web Editor having every one of the thousands of Library Manager libraries
pre-installed does result in a higher incidence of header filename collisions. This means it is especially important for
Arduino Web Editor users to understand library location priorities.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Sep 24, 2020
@per1234 per1234 requested a review from cmaglie September 25, 2020 10:27
@per1234 per1234 merged commit 4e8bd61 into arduino:master Sep 25, 2020
@per1234 per1234 deleted the web-editor-library-location-priorities branch October 14, 2020 17:06
@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