Skip to content

Commit 89672af

Browse files
committed
Updated docs
1 parent cf75835 commit 89672af

File tree

3 files changed

+20
-3
lines changed

3 files changed

+20
-3
lines changed

Diff for: docs/UPGRADING.md

+13
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,19 @@ Old code must change the imports accordingly.
316316
317317
If you're not interested in getting the task events you can pass an empty callback function.
318318
319+
### Removed detection of Arduino IDE bundling
320+
321+
Arduino CLI does not check anymore if it's bundled with the Arduino IDE. Previously this check allowed the Arduino CLI
322+
to automatically use the libraries and tools bundled in the Arduino IDE, now this is not supported anymore unless the
323+
configuration keys `directories.builtin.libraries` and `directories.builtin.tools` are set.
324+
325+
### go-lang functions changes in `github.com/arduino/arduino-cli/configuration`
326+
327+
- `github.com/arduino/arduino-cli/configuration.IsBundledInDesktopIDE` function has been removed.
328+
- `github.com/arduino/arduino-cli/configuration.BundleToolsDirectories` has been renamed to `BuiltinToolsDirectories`
329+
- `github.com/arduino/arduino-cli/configuration.IDEBundledLibrariesDir` now returns a `paths.PathList` instead of a
330+
`*paths.Path`
331+
319332
## 0.25.0
320333
321334
### go-lang function `github.com/arduino/arduino-cli/arduino/utils.FeedStreamTo` has been changed

Diff for: docs/configuration.md

+5
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@
99
- `downloads` - directory used to stage downloaded archives during Boards/Library Manager installations.
1010
- `user` - the equivalent of the Arduino IDE's ["sketchbook" directory][sketchbook directory]. Library Manager
1111
installations are made to the `libraries` subdirectory of the user directory.
12+
- `builtin.libraries` - the libraries in this directory will be available to all platforms without the need for the
13+
user to install them, but with the lowest priority over other installed libraries with the same name, it's the
14+
equivalent of the Arduino IDE's bundled libraries directory.
15+
- `builtin.tools` - it's a list of directories of tools that will be available to all platforms without the need for
16+
the user to install them, it's the equivalent of the Arduino IDE's bundled tools directory.
1217
- `library` - configuration options relating to Arduino libraries.
1318
- `enable_unsafe_install` - set to `true` to enable the use of the `--git-url` and `--zip-file` flags with
1419
[`arduino-cli lib install`][arduino cli lib install]. These are considered "unsafe" installation methods because

Diff for: docs/sketch-build-process.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -130,9 +130,8 @@ The "location priority" is determined as follows (in order of highest to lowest
130130
([`{runtime.platform.path}/libraries`](platform-specification.md#global-predefined-properties))
131131
1. The library is bundled with the [referenced](platform-specification.md#referencing-another-core-variant-or-tool)
132132
board platform/core
133-
1. The library is bundled with the Arduino IDE
134-
([`{runtime.ide.path}/libraries`](platform-specification.md#global-predefined-properties))
135-
- This location is only used by Arduino CLI when it's located in the Arduino IDE installation folder
133+
1. The library is bundled with the Arduino IDE (this location is determined by the Arduino CLI configuration setting
134+
`directories.builtin.libraries`)
136135

137136
#### Location priorities in Arduino Web Editor
138137

0 commit comments

Comments
 (0)