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
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/sketch-build-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,27 @@ The "location priority" is determined as follows (in order of highest to lowest
([`{runtime.ide.path}/libraries`](platform-specification.md#global-predefined-properties))
- This location is only used by Arduino CLI when it's located in the Arduino IDE installation folder

#### Location priorities in Arduino Web Editor

The location priorities system works in the same manner in [Arduino Web Editor](https://create.arduino.cc/editor), but
its cloud-based nature may make the locations of libraries less obvious.

1. **Custom**: the imported libraries, shown under the **Libraries > Custom** tab.
- These libraries are under `/tmp/\<some number>/custom`
1. **Pinned**: libraries that were [associated with the sketch](sketch-specification.md#metadata) by choosing a specific
version from the library's "Include" dropdown menu.
- These libraries are under `/tmp/\<some number>/pinned`
- Note: clicking the "Include" button does not result in the library being pinned to the sketch.
1. **[Platform bundled](platform-specification.md#platform-bundled-libraries)**: these are listed under the
**Libraries > Default** tab, but with "for \<architecture name\>" appended to the library name (e.g., "SPI for AVR").
- These libraries are under `/home/builder/.arduino15/packages`
1. [Board platform](platform-specification.md#platform-terminology) bundled
1. [Core platform](platform-specification.md#platform-terminology) bundled
1. **Built-in**:
- The non-platform bundled libraries listed under the **Libraries > Default** tab.
- Libraries listed under **Libraries > Library Manager**.
- These libraries are under `/home/builder/opt/libraries/latest`

## Compilation

Sketches are compiled by avr-gcc and avr-g++ according to the variables in the boards.txt file of the selected board's
Expand Down