From 36a5b2baa6fabc2bb8f8389e2654bf1edcb1d968 Mon Sep 17 00:00:00 2001 From: Alessio Perugini Date: Wed, 8 Nov 2023 18:21:55 +0100 Subject: [PATCH] update docs --- docs/UPGRADING.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/UPGRADING.md b/docs/UPGRADING.md index d329a804e62..8df74a7f9f0 100644 --- a/docs/UPGRADING.md +++ b/docs/UPGRADING.md @@ -7,18 +7,23 @@ Here you can find a list of migration guides to handle breaking changes between ### The gRPC `cc.arduino.cli.commands.v1.PlatformRelease` has been changed. We've added a new field called `compatible`. This field indicates if the current platform release is installable or not. -It may happen that a platform doesn't have a dependency available for an OS, in such cases, if we try to install the -platform it will fail. The new field can be used to know upfront if a specific release is installable. +It may happen that a platform doesn't have a dependency available for an OS/ARCH, in such cases, if we try to install +the platform it will fail. The new field can be used to know upfront if a specific release is installable. ### The gRPC `cc.arduino.cli.commands.v1.PlatformSummary` has been changed. -We've added a new field called `latest_compatible_version`. This field indicates the latest version that can be -successfully installed for the current OS. The `latest_version` field cannot guarantee such property. +We've modified the behavior of `latest_version`. Now this field indicates the latest version that can be installed in +the current OS/ARCH. ### `core list` now returns only the latest version that can be installed. -Previously, we showed the latest version without checking if all the dependencies were available in the current OS. Now, -the latest version will always point to an installable one even if a newer incompatible one is present. +Previously, we showed the latest version without checking if all the dependencies were available in the current OS/ARCH. +Now, the latest version will always point to an installable one even if a newer incompatible one is present. + +### `core search` now shows only the cores that are installable. + +Previously, if a core had no installable release it was shown anyway. Now only cores that contain at least 1 installable +releases are returned. ### `core upgrade` and `core install` will install the latest compatible version.