Skip to content

Commit e93b80e

Browse files
committed
Better specify discoveryDependencies and monitorDependencies fields in package_index.json
1 parent e774783 commit e93b80e

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/package_index_json-specification.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -247,13 +247,15 @@ Each PLATFORM describes a core for a specific architecture. The fields needed ar
247247
platform. Each tool is referenced by the triple (`packager`, `name`, `version`) as previously said. Note that you can
248248
reference tools available in other packages as well, even if no platform of that package is installed.
249249
- `discoveryDependencies`: the Pluggable Discoveries needed by this platform. Each discovery is referenced by the pair
250-
(`packager`, `name`), the `version` is not specified because the latest installed discovery tool will always be used.
251-
Like `toolsDependencies` they will be installed by Boards Manager along with the platform and can reference tools
252-
available in other packages as well, even if no platform of that package is installed.
250+
(`packager`, `name`). The Pluggable Discoveries must be part of `tools` section of the platform. The `version` is not
251+
specified because the latest available discovery tool will always be used. Like `toolsDependencies` they will be
252+
installed by Boards Manager along with the platform and can reference tools available in other packages as well, even
253+
if no platform of that package is installed.
253254
- `monitorDependencies`: the Pluggable Monitors needed by this platform. Each monitor is referenced by the pair
254-
(`packager`, `name`), the `version` is not specified because the latest installed monitor tool will always be used.
255-
Like `toolsDependencies` they will be installed by Boards Manager along with the platform and can reference tools
256-
available in other packages as well, even if no platform of that package is installed.
255+
(`packager`, `name`). The Pluggable Monitors must be part of `tools` section of the platform. The `version` is not
256+
specified because the latest available monitor tool will always be used. Like `toolsDependencies` they will be
257+
installed by Boards Manager along with the platform and can reference tools available in other packages as well, even
258+
if no platform of that package is installed.
257259

258260
The `version` field is validated by both Arduino IDE and [JSemVer](https://github.com/zafarkhaja/jsemver). Here are the
259261
rules Arduino IDE follows for parsing versions

0 commit comments

Comments
 (0)