Skip to content

Commit c886915

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

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

docs/package_index_json-specification.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -246,14 +246,16 @@ Each PLATFORM describes a core for a specific architecture. The fields needed ar
246246
- `toolsDependencies`: the tools needed by this platform. They will be installed by Boards Manager along with the
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.
249-
- `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.
253-
- `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.
249+
- `discoveryDependencies`: the Pluggable Discoveries needed by this platform. These are [tools](#tools-definitions),
250+
defined exactly like the ones referenced in `toolsDependencies`. Unlike `toolsDependencies`, discoveries are
251+
referenced by the pair (`packager`, `name`). The `version` is not specified because the latest installed discovery
252+
tool will always be used. Like `toolsDependencies` they will be installed by Boards Manager along with the platform
253+
and can reference tools available in other packages as well, even if no platform of that package is installed.
254+
- `monitorDependencies`: the Pluggable Monitors needed by this platform. These are [tools](#tools-definitions), defined
255+
exactly like the ones referenced in `toolsDependencies`. Unlike `toolsDependencies`, monitors are referenced by the
256+
pair (`packager`, `name`). The `version` is not specified because the latest installed monitor tool will always be
257+
used. Like `toolsDependencies` they will be installed by Boards Manager along with the platform and can reference
258+
tools available in other packages as well, even 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)