Skip to content

[skip changelog] Use consistent indentation style in example snippets of package_index.json specification #815

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 10, 2020
Merged

[skip changelog] Use consistent indentation style in example snippets of package_index.json specification #815

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e37567d
Use consistent index size for snippets in package_index.json specific…
per1234 Jul 10, 2020
361ca73
Use true indentation level for package definition example snippet
per1234 Jul 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions docs/package_index_json-specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,35 +26,35 @@ The root of the JSON index is an array of `packages`:
```json
{
"packages": [
PACKAGE_XXXX
]
PACKAGE_XXXX
]
}
```

3rd party vendors should use a single `PACKAGE_XXXX` that is a dictionary map with the vendor's metadata, a list of `PLATFORMS` and a list of `TOOLS`. For example:

```json
{
"name": "arduino",
"maintainer": "Arduino LLC",
"websiteURL": "http://www.arduino.cc/",
"email": "[email protected]",

"platforms": [
PLATFORM_AVR,
PLATFORM_ARM,
PLATFORM_XXXXX,
PLATFORM_YYYYY,
],

"tools": [
TOOLS_COMPILER_AVR,
TOOLS_UPLOADER_AVR,
TOOLS_COMPILER_ARM,
TOOLS_XXXXXXX,
TOOLS_YYYYYYY,
],
}
{
"name": "arduino",
"maintainer": "Arduino LLC",
"websiteURL": "http://www.arduino.cc/",
"email": "[email protected]",

"platforms": [
PLATFORM_AVR,
PLATFORM_ARM,
PLATFORM_XXXXX,
PLATFORM_YYYYY,
],

"tools": [
TOOLS_COMPILER_AVR,
TOOLS_UPLOADER_AVR,
TOOLS_COMPILER_ARM,
TOOLS_XXXXXXX,
TOOLS_YYYYYYY,
],
}
```

The metadata fields are:
Expand Down