Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 520de09

Browse filesBrowse files
committed
Updated docs
1 parent c42c991 commit 520de09
Copy full SHA for 520de09

File tree

Expand file treeCollapse file tree

3 files changed

+35
-3
lines changed
Filter options
Expand file treeCollapse file tree

3 files changed

+35
-3
lines changed

‎docs/UPGRADING.md

Copy file name to clipboardExpand all lines: docs/UPGRADING.md
+28Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,34 @@ must be changed to:
266266
eventsChan, closeWatcher, err := board.Watch(req)
267267
```
268268

269+
### Removed detection of Arduino IDE bundling
270+
271+
Arduino CLI does not check anymore if it's bundled with the Arduino IDE. Previously this check allowed the Arduino CLI
272+
to automatically use the libraries and tools bundled in the Arduino IDE, now this is not supported anymore unless the
273+
configuration keys `directories.builtin.libraries` and `directories.builtin.tools` are set.
274+
275+
### gRPC enumeration renamed enum value in `cc.arduino.cli.commands.v1.LibraryLocation`
276+
277+
`LIBRARY_LOCATION_IDE_BUILTIN` has been renamed to `LIBRARY_LOCATION_BUILTIN`
278+
279+
### go-lang API change in `LibraryManager`
280+
281+
```go
282+
func (lm *LibrariesManager) InstallPrerequisiteCheck(indexLibrary *librariesindex.Release) (*paths.Path, *libraries.Library, error) { ... }
283+
func (lm *LibrariesManager) Install(indexLibrary *librariesindex.Release, libPath *paths.Path) error { ... ]
284+
```
285+
286+
```go
287+
func (lm *LibrariesManager) InstallPrerequisiteCheck(indexLibrary *librariesindex.Release, installLocation libraries.LibraryLocation) (*paths.Path, *libraries.Library, error) { ... }
288+
func (lm *LibrariesManager) Install(indexLibrary *librariesindex.Release, libPath *paths.Path, installLocation libraries.LibraryLocation) error { ... ]
289+
```
290+
291+
### go-lang functions changes in `github.com/arduino/arduino-cli/configuration`
292+
293+
- `github.com/arduino/arduino-cli/configuration.IsBundledInDesktopIDE` function has been removed.
294+
- `github.com/arduino/arduino-cli/configuration.BundleToolsDirectories` has been renamed to `BuiltinToolsDirectories`
295+
- `github.com/arduino/arduino-cli/configuration.IDEBundledLibrariesDir` has been renamed to `IDEBuiltinLibrariesDir`
296+
269297
## 0.26.0
270298
271299
### `github.com/arduino/arduino-cli/commands.DownloadToolRelease`, and `InstallToolRelease` functions have been removed

‎docs/configuration.md

Copy file name to clipboardExpand all lines: docs/configuration.md
+5Lines changed: 5 additions & 0 deletions
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

‎docs/sketch-build-process.md

Copy file name to clipboardExpand all lines: docs/sketch-build-process.md
+2-3Lines changed: 2 additions & 3 deletions
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 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.