Skip to content

Commit 14e0d5c

Browse files
update docs
1 parent ffbd9a8 commit 14e0d5c

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

Diff for: docs/UPGRADING.md

+14-8
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,30 @@ 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 returns the latest installable version of a core.
24+
25+
We now show in the `version` column the latest installable version. If none are available then we show a `n/a` label.
26+
The corresponding command with `--format json` now returns the same output of
27+
`arduino-cli core search --all --format json`.
2228

2329
### `core upgrade` and `core install` will install the latest compatible version.
2430

2531
Previously, we'd have tried the installation/upgrade of a core even if all the required tools weren't available in the
26-
current OS. Now we check this upfront, and allowing the installation of incompatible versions only if a user explicitly
27-
provides it like: `core install arduino:[email protected]`
32+
current OS/ARCH. Now we check this upfront, and allowing the installation of incompatible versions only if a user
33+
explicitly provides it like: `core install arduino:[email protected]`
2834

2935
### gRPC service `cc.arduino.cli.settings.v1` has been removed, and all RPC calls have been migrated to `cc.arduino.cli.commands.v1`
3036

0 commit comments

Comments
 (0)