Skip to content

Commit f7d5354

Browse files
committed
Updated documentation
1 parent cf9bc04 commit f7d5354

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/UPGRADING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,17 @@ but since it has been the default behaviour from a very long time we decided to
1313
If a compilation fail for a missing bundled library, you can fix it just by installing the missing library from the
1414
library manager as usual.
1515

16+
### gRPC: Changes in message `cc.arduino.cli.commands.v1.PlatformReference`
17+
18+
The gRPC message structure `cc.arduino.cli.commands.v1.PlatformReference` has been renamed to
19+
`cc.arduino.cli.commands.v1.InstalledPlatformReference`, and some new fields have been added:
20+
21+
- `install_dir` is the installation directory of the platform
22+
- `package_url` is the 3rd party platform URL of the platform
23+
24+
It is currently used only in `cc.arduino.cli.commands.v1.CompileResponse`, so the field type has been changed as well.
25+
Old gRPC clients must only update gRPC bindings. They can safely ignore the new fields if not needed.
26+
1627
### golang API: PackageManager.DownloadPlatformRelease no longer need `label` parameter
1728

1829
```go

0 commit comments

Comments
 (0)