Skip to content

Commit b814e2a

Browse files
authored
[skip changelog] Update sketch specification to reflect support for port attachment (#790)
arduino-cli board attach <port> now associates the port with the sketch (hooray!!!). The sketch specification's metadata section was written before this change was made and so only mentioned the FQBN association capabilities.
1 parent 65e4f1d commit b814e2a

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/sketch-specification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The Arduino IDE's **File > Save As...** only copies the code files in the sketch
5555

5656
Arduino CLI and Arduino Web Editor use a file named sketch.json, located in the sketch root folder, to store sketch metadata.
5757

58-
The `cpu` key contains the board configuration information. This can be set via [`arduino-cli board attach`](https://arduino.github.io/arduino-cli/commands/arduino-cli_board_attach/) or by selecting a board in the Arduino Web Editor while the sketch is open. With this configuration set, it is not necessary to specify the `--fqbn` flag to the [`arduino-cli compile`](https://arduino.github.io/arduino-cli/commands/arduino-cli_compile/) or [`arduino-cli upload`](https://arduino.github.io/arduino-cli/commands/arduino-cli_upload/) commands when compiling or uploading the sketch.
58+
The `cpu` key contains the board configuration information. This can be set via [`arduino-cli board attach`](https://arduino.github.io/arduino-cli/commands/arduino-cli_board_attach/) or by selecting a board in the Arduino Web Editor while the sketch is open. With this configuration set, it is not necessary to specify the `--fqbn` or `--port` flags to the [`arduino-cli compile`](https://arduino.github.io/arduino-cli/commands/arduino-cli_compile/) or [`arduino-cli upload`](https://arduino.github.io/arduino-cli/commands/arduino-cli_upload/) commands when compiling or uploading the sketch.
5959

6060
The `included_libs` key defines the library versions the Arduino Web Editor uses when the sketch is compiled. This is Arduino Web Editor specific because all versions of all the Library Manager libraries are pre-installed in Arduino Web Editor, while only one version of each library may be installed when using the other Arduino development software.
6161

0 commit comments

Comments
 (0)