Skip to content

Commit 41bffac

Browse files
authored
[skip changelog] Update the tool definition example (#1024)
The old tool definition example in the package_index.json specification was quite outdated. It did not demonstrate the ARM hosts that have become more important since the specification was written. The macOS host value was antiquated. This could lead to the reader being left with no clear idea of how to create the tool definitions for those hosts.
1 parent 3d05ade commit 41bffac

File tree

1 file changed

+42
-26
lines changed

1 file changed

+42
-26
lines changed

docs/package_index_json-specification.md

Lines changed: 42 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -90,35 +90,49 @@ Tools are mapped as JSON in this way:
9090
```json
9191
{
9292
"name": "avr-gcc",
93-
"version": "4.8.1-arduino5",
93+
"version": "7.3.0-atmel3.6.1-arduino7",
9494
"systems": [
9595
{
96-
"host": "i386-apple-darwin11",
97-
"url": "http://downloads.arduino.cc/tools/avr-gcc-4.8.1-arduino5-i386-apple-darwin11.tar.bz2",
98-
"archiveFileName": "avr-gcc-4.8.1-arduino5-i386-apple-darwin11.tar.bz2",
99-
"size": "24437400",
100-
"checksum": "SHA-256:111b3ef00d737d069eb237a8933406cbb928e4698689e24663cffef07688a901"
96+
"size": "34683056",
97+
"checksum": "SHA-256:3903553d035da59e33cff9941b857c3cb379cb0638105dfdf69c97f0acc8e7b5",
98+
"host": "arm-linux-gnueabihf",
99+
"archiveFileName": "avr-gcc-7.3.0-atmel3.6.1-arduino7-arm-linux-gnueabihf.tar.bz2",
100+
"url": "http://downloads.arduino.cc/tools/avr-gcc-7.3.0-atmel3.6.1-arduino7-arm-linux-gnueabihf.tar.bz2"
101101
},
102102
{
103-
"host": "x86_64-linux-gnu",
104-
"url": "http://downloads.arduino.cc/tools/avr-gcc-4.8.1-arduino5-x86_64-pc-linux-gnu.tar.bz2",
105-
"archiveFileName": "avr-gcc-4.8.1-arduino5-x86_64-pc-linux-gnu.tar.bz2",
106-
"size": "27093036",
107-
"checksum": "SHA-256:9054fcc174397a419ba56c4ce1bfcbcad275a6a080cc144905acc9b0351ee9cc"
103+
"size": "38045723",
104+
"checksum": "SHA-256:03d322b9df6da17289e9e7c6233c34a8535d9c645c19efc772ba19e56914f339",
105+
"host": "aarch64-linux-gnu",
106+
"archiveFileName": "avr-gcc-7.3.0-atmel3.6.1-arduino7-aarch64-pc-linux-gnu.tar.bz2",
107+
"url": "http://downloads.arduino.cc/tools/avr-gcc-7.3.0-atmel3.6.1-arduino7-aarch64-pc-linux-gnu.tar.bz2"
108108
},
109109
{
110-
"host": "i686-linux-gnu",
111-
"url": "http://downloads.arduino.cc/tools/avr-gcc-4.8.1-arduino5-i686-pc-linux-gnu.tar.bz2",
112-
"archiveFileName": "avr-gcc-4.8.1-arduino5-i686-pc-linux-gnu.tar.bz2",
113-
"size": "25882375",
114-
"checksum": "SHA-256:7648b7f549b37191da0b0be53bae791b652f82ac3cb4e7877f85075aaf32141f"
110+
"size": "36684546",
111+
"checksum": "SHA-256:f6ed2346953fcf88df223469088633eb86de997fa27ece117fd1ef170d69c1f8",
112+
"host": "x86_64-apple-darwin14",
113+
"archiveFileName": "avr-gcc-7.3.0-atmel3.6.1-arduino7-x86_64-apple-darwin14.tar.bz2",
114+
"url": "http://downloads.arduino.cc/tools/avr-gcc-7.3.0-atmel3.6.1-arduino7-x86_64-apple-darwin14.tar.bz2"
115115
},
116116
{
117+
"size": "52519412",
118+
"checksum": "SHA-256:a54f64755fff4cb792a1495e5defdd789902a2a3503982e81b898299cf39800e",
117119
"host": "i686-mingw32",
118-
"url": "http://downloads.arduino.cc/tools/avr-gcc-4.8.1-arduino5-i686-mingw32.zip",
119-
"archiveFileName": "avr-gcc-4.8.1-arduino5-i686-mingw32.zip",
120-
"size": "46044779",
121-
"checksum": "SHA-256:d4303226a7b41d3c445d901b5aa5903458def3fc7b7ff4ffef37cabeb37d424d"
120+
"archiveFileName": "avr-gcc-7.3.0-atmel3.6.1-arduino7-i686-w64-mingw32.zip",
121+
"url": "http://downloads.arduino.cc/tools/avr-gcc-7.3.0-atmel3.6.1-arduino7-i686-w64-mingw32.zip"
122+
},
123+
{
124+
"size": "37176991",
125+
"checksum": "SHA-256:954bbffb33545bcdcd473af993da2980bf32e8461ff55a18e0eebc7b2ef69a4c",
126+
"host": "i686-linux-gnu",
127+
"archiveFileName": "avr-gcc-7.3.0-atmel3.6.1-arduino7-i686-pc-linux-gnu.tar.bz2",
128+
"url": "http://downloads.arduino.cc/tools/avr-gcc-7.3.0-atmel3.6.1-arduino7-i686-pc-linux-gnu.tar.bz2"
129+
},
130+
{
131+
"size": "37630618",
132+
"checksum": "SHA-256:bd8c37f6952a2130ac9ee32c53f6a660feb79bee8353c8e289eb60fdcefed91e",
133+
"host": "x86_64-linux-gnu",
134+
"archiveFileName": "avr-gcc-7.3.0-atmel3.6.1-arduino7-x86_64-pc-linux-gnu.tar.bz2",
135+
"url": "http://downloads.arduino.cc/tools/avr-gcc-7.3.0-atmel3.6.1-arduino7-x86_64-pc-linux-gnu.tar.bz2"
122136
}
123137
]
124138
},
@@ -128,9 +142,9 @@ The field `name` and `version` are respectively the name and version of the tool
128142
the triple (`packager`, `name`, `version`). `packager` (AKA "vendor") is defined by the `name` value of the tool's
129143
package. There can be many different versions of the same tool available at the same time, for example:
130144

131-
- (`arduino`, `avr-gcc`, `4.8.1-arduino2`)
132-
- (`arduino`, `avr-gcc`, `4.8.1-arduino3`)
133-
- (`arduino`, `avr-gcc`, `4.8.1-arduino5`)
145+
- (`arduino`, `avr-gcc`, `5.4.0-atmel3.6.1-arduino2`)
146+
- (`arduino`, `avr-gcc`, `7.3.0-atmel3.6.1-arduino5`)
147+
- (`arduino`, `avr-gcc`, `7.3.0-atmel3.6.1-arduino7`)
134148
- (`arduino`, `avrdude`, `5.11`)
135149
- (`arduino`, `avrdude`, `6.0`)
136150
- (`arduino`, `avrdude`, `6.1`)
@@ -139,10 +153,12 @@ package. There can be many different versions of the same tool available at the
139153
Each tool version may come in different build flavours for different OS. Each flavour is listed under the `systems`
140154
array. In the example above `avr-gcc` comes with builds for:
141155

142-
- Linux 64-bit (`x86_64-linux-gnu`),
143-
- Linux 32-bit (`i686-linux-gnu`),
156+
- ARM Linux 32-bit (`arm-linux-gnueabihf`),
157+
- ARM Linux 64-bit (`aarch64-linux-gnu`),
158+
- macOS 64-bit (`x86_64-apple-darwin14`),
144159
- Windows (`i686-mingw32`),
145-
- Mac (`i386-apple-darwin11`)
160+
- Linux 32-bit (`i686-linux-gnu`),
161+
- Linux 64-bit (`x86_64-linux-gnu`)
146162

147163
The IDE will take care to install the right flavour based on the `host` value, or fail if a needed flavour is
148164
missing.<br> Note that this information is not used to select the toolchain during compilation. If you want this

0 commit comments

Comments
 (0)