Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
c7d0cb4
Added gRPC functions to manage libraries in profiles
cmaglie Oct 3, 2025
92cf64f
Removed ProfileDump gRPC command.
cmaglie Oct 6, 2025
ed5d6a2
Moved SketchProfileLibraryReference in the proper commono.proto file
cmaglie Oct 6, 2025
c74f073
linter: removed unneeded type specification
cmaglie Oct 6, 2025
34c378c
Renamed SketchProfileLibraryReference -> ProfileLibraryReference
cmaglie Oct 22, 2025
0c78b3f
Renamed InitProfile -> ProfileCreate
cmaglie Oct 22, 2025
3c5a3c9
Small refactoring, no code change
cmaglie Oct 23, 2025
4d78f7f
Fixed error messages
cmaglie Oct 23, 2025
d4cbad2
Removed unnecessary type specifier
cmaglie Oct 24, 2025
140c069
Refactored libraryResolveDependencies.
cmaglie Oct 27, 2025
5ac03d8
Added support for 'dependency:' field in profiles libraries
cmaglie Oct 29, 2025
e17724b
ProfileLibAdd and ProfileLibRemove can now cleanup unneeded dependencies
cmaglie Oct 29, 2025
4bb86e7
Better error messages
cmaglie Nov 21, 2025
f520cb9
Simplified Profile.RemoveLibrary(...) method.
cmaglie Nov 21, 2025
4e80e73
Fixed algorithm for determination of required deps
cmaglie Nov 21, 2025
dbafbe6
Updated docs
cmaglie Nov 25, 2025
4f527c0
Rename DuplicateProfileError -> ProfileAlreadyExitsError
cmaglie Nov 26, 2025
1909ab7
Removed useless field in gRPC ProfileCreateResponse
cmaglie Nov 26, 2025
8b4b3a5
fix: ProfileCreate sets the new profile as default only if asked to d…
cmaglie Nov 26, 2025
ad5d941
Improved docs
cmaglie Dec 1, 2025
3a14601
Applied code review suggestion
cmaglie Dec 1, 2025
2aa7e32
Using cmp.Or helper
cmaglie Dec 1, 2025
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Updated docs
  • Loading branch information
cmaglie committed Nov 26, 2025
commit dbafbe64bc2b92ad69cbcc8c54c36e3cb8714110
11 changes: 9 additions & 2 deletions docs/sketch-project-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ profiles:
platform_index_url: <3RD_PARTY_PLATFORM_DEPENDENCY_URL>
libraries:
- <INDEX_LIB_NAME> (<INDEX_LIB_VERSION>)
- dependency: <INDEX_LIB_NAME> (<INDEX_LIB_VERSION>)
- dir: <LOCAL_LIB_PATH>
port: <PORT_NAME>
port_config:
Expand All @@ -56,8 +57,14 @@ otherwise below). The available fields are:
information as `<PLATFORM>`, `<PLATFORM_VERSION>`, and `<3RD_PARTY_PLATFORM_URL>` respectively but for the core
platform dependency of the main core platform. These fields are optional.
- `libraries:` is a section where the required libraries to build the project are defined. This section is optional.
- `<INDEX_LIB_NAME> (<INDEX_LIB_VERSION>)` represents a library from the Arduino Libraries Index, for example,
`MyLib (1.0.0)`.
- `<INDEX_LIB_NAME> (<INDEX_LIB_VERSION>)` represents a library from the Arduino Libraries Index that is a direct
dependency of the sketch, for example, `MyLib (1.0.0)`.
- `dependency: <INDEX_LIB_NAME> (<INDEX_LIB_VERSION>)` represents a library from the Arduino Libraries Index that is
an "indirect dependency", i.e., a library that is not used directly by the sketch, but is required by other
libraries used by the sketch. For example, if `LibUsedInSketch` requires `UtilLib`, this information can be recorded
in the profile with the declaration `dependency: UtilLib (1.3.4)`. During sketch compilation, a dependency library
is treated the same as a non-dependency library; the only difference is in automatic library management, where a
dependency library can be installed or removed together with the library that uses it.
- `dir: <LOCAL_LIB_PATH>` represents a library installed in the filesystem and `<LOCAL_LIB_PATH>` is the path to the
library. The path could be absolute or relative to the sketch folder. This option is available since Arduino CLI
1.3.0.
Expand Down