Skip to content

Commit 102726d

Browse files
[skip changelog] Apply suggestions from code review
Co-authored-by: per1234 <[email protected]>
1 parent 9cc2c63 commit 102726d

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/UPGRADING.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,12 @@ The `debug.xxx=yyy` definitions above may be supplied and overlayed in the usual
4343
Previously, if the `--build-path` was not specified, compiling a Sketch would copy the generated binaries in
4444
`<sketch_folder>/build/<fqbn>/`, uploading to a board required that path to exist and contain the necessary binaries.
4545

46-
The `--dry-run` flag is removed, `compile` now never copies generated binaries to the sketch folder. The
47-
`--export-binaries` (`-e`) flag is introduced to copy the binaries from the build folder to the sketch one. Specifying
48-
the `--output-dir` doesn't require using setting also the `--export-binaries` flag. A related settings and env var has
49-
been added to avoid the need to always specify the `--export-binaries` flag: `sketch.always_export_binaries` and
46+
The `--dry-run` flag was removed.
47+
48+
The default, `compile` does not copy generated binaries to the sketch folder. The `--export-binaries` (`-e`) flag was
49+
introduced to copy the binaries from the build folder to the sketch one. `--export-binaries` is not required when using
50+
the `--output-dir` flag. A related configuration key and environment variable has been added to avoid the need to
51+
always specify the `--export-binaries` flag: `sketch.always_export_binaries` and
5052
`ARDUINO_SKETCH_ALWAYS_EXPORT_BINARIES`.
5153

5254
If `--input-dir` or `--input-file` is not set when calling `upload` the command will search for the deterministically
@@ -56,12 +58,12 @@ The gRPC interface has been updated accordingly, `dryRun` is removed.
5658

5759
### Programmers can't be listed anymore using `burn-bootloader -P list`
5860

59-
The `-P` flags is meant to select the programmer used to burn the bootloader on the specified board, the `-P list` was
60-
an hackish way to list all the possible programmers that could be used for that board.
61+
The `-P` flag is used to select the programmer used to burn the bootloader on the specified board. Using `-P list` to
62+
list all the possible programmers for the current board was hackish.
6163

6264
This way has been removed in favour of `board details <fqbn> --list-programmers`.
6365

64-
### `lib install --git-url` and `--zip-file` must now be esplicitly enabled
66+
### `lib install --git-url` and `--zip-file` must now be explicitly enabled
6567

6668
With the introduction of the `--git-url` and `--zip-file` flags the new config key `library.enable_unsafe_install` has
6769
been added to enable them.

0 commit comments

Comments
 (0)