Skip to content

Commit 1bd9945

Browse files
authored
[skip changelog] Document packages[*].platforms[*].deprecated package index field (#1510)
In the event an Arduino boards platform is deprecated by the maintainer, it will be useful to clearly communicate this fact to the user and ensure they will easily find a preferred alternative platform. In order to facilitate this, a `packages[*].platforms[*].deprecated`field was added to the Arduino package index format and this information is used to enhance the user interfaces of the official Arduino development software. This useful feature is now documented in the Arduino package index specification.
1 parent ba8c9b7 commit 1bd9945

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/package_index_json-specification.md

+3
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,9 @@ Each PLATFORM describes a core for a specific architecture. The fields needed ar
234234
- `architecture`: is the architecture of the platform (avr, sam, etc...). It must match the architecture of the core as
235235
explained in the [Arduino platform specification](platform-specification.md#hardware-folders-structure)
236236
- `version`: the version of the platform.
237+
- `deprecated`: (optional) setting to `true` causes the platform to be moved to the bottom of all Boards Manager and
238+
[`arduino-cli core`](https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_core/) listings and marked
239+
"DEPRECATED".
237240
- `category`: this field is reserved, a 3rd party core must set it to `Contributed`
238241
- `help`/`online`: is a URL that is displayed on the Arduino IDE's Boards Manager as an "Online Help" link
239242
- `url`, `archiveFileName`, `size` and `checksum`: metadata of the core archive file. The meaning is the same as for the

0 commit comments

Comments
 (0)