Skip to content

Commit 9cc2c63

Browse files
committed
[skip changelog] Update UPGRADING.md with new breaking changes
1 parent 7d4baa9 commit 9cc2c63

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/UPGRADING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,33 @@ The `debug.xxx=yyy` definitions above may be supplied and overlayed in the usual
3737
- on `platform.txt`: definition here will be shared through all boards in the platform
3838
- on `boards.txt` as part of a board definition: they will override the global platform definitions
3939
- on `programmers.txt`: they will override the boards and global platform definitions if the programmer is selected
40+
41+
### Binaries export must now be explicitly specified
42+
43+
Previously, if the `--build-path` was not specified, compiling a Sketch would copy the generated binaries in
44+
`<sketch_folder>/build/<fqbn>/`, uploading to a board required that path to exist and contain the necessary binaries.
45+
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
50+
`ARDUINO_SKETCH_ALWAYS_EXPORT_BINARIES`.
51+
52+
If `--input-dir` or `--input-file` is not set when calling `upload` the command will search for the deterministically
53+
created build directory in the temp folder and use the binaries found there.
54+
55+
The gRPC interface has been updated accordingly, `dryRun` is removed.
56+
57+
### Programmers can't be listed anymore using `burn-bootloader -P list`
58+
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+
62+
This way has been removed in favour of `board details <fqbn> --list-programmers`.
63+
64+
### `lib install --git-url` and `--zip-file` must now be esplicitly enabled
65+
66+
With the introduction of the `--git-url` and `--zip-file` flags the new config key `library.enable_unsafe_install` has
67+
been added to enable them.
68+
69+
This changes the ouput of the `config dump` command.

0 commit comments

Comments
 (0)