Skip to content

Commit 36a5b2b

Browse files
update docs
1 parent edcdefa commit 36a5b2b

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

docs/UPGRADING.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,23 @@ Here you can find a list of migration guides to handle breaking changes between
77
### The gRPC `cc.arduino.cli.commands.v1.PlatformRelease` has been changed.
88

99
We've added a new field called `compatible`. This field indicates if the current platform release is installable or not.
10-
It may happen that a platform doesn't have a dependency available for an OS, in such cases, if we try to install the
11-
platform it will fail. The new field can be used to know upfront if a specific release is installable.
10+
It may happen that a platform doesn't have a dependency available for an OS/ARCH, in such cases, if we try to install
11+
the platform it will fail. The new field can be used to know upfront if a specific release is installable.
1212

1313
### The gRPC `cc.arduino.cli.commands.v1.PlatformSummary` has been changed.
1414

15-
We've added a new field called `latest_compatible_version`. This field indicates the latest version that can be
16-
successfully installed for the current OS. The `latest_version` field cannot guarantee such property.
15+
We've modified the behavior of `latest_version`. Now this field indicates the latest version that can be installed in
16+
the current OS/ARCH.
1717

1818
### `core list` now returns only the latest version that can be installed.
1919

20-
Previously, we showed the latest version without checking if all the dependencies were available in the current OS. Now,
21-
the latest version will always point to an installable one even if a newer incompatible one is present.
20+
Previously, we showed the latest version without checking if all the dependencies were available in the current OS/ARCH.
21+
Now, the latest version will always point to an installable one even if a newer incompatible one is present.
22+
23+
### `core search` now shows only the cores that are installable.
24+
25+
Previously, if a core had no installable release it was shown anyway. Now only cores that contain at least 1 installable
26+
releases are returned.
2227

2328
### `core upgrade` and `core install` will install the latest compatible version.
2429

0 commit comments

Comments
 (0)