Skip to content

Commit ff308cf

Browse files
silvanocerzaper1234
andcommitted
[skip changelog] Update UPGRADING.md with new breaking changes (#1101)
* [skip changelog] Update UPGRADING.md with new breaking changes * [skip changelog] Apply suggestions from code review Co-authored-by: per1234 <[email protected]> Co-authored-by: per1234 <[email protected]>
1 parent 7d4baa9 commit ff308cf

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

Diff for: docs/UPGRADING.md

+31
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,34 @@ 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 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 always
51+
specify the `--export-binaries` flag: `sketch.always_export_binaries` and `ARDUINO_SKETCH_ALWAYS_EXPORT_BINARIES`.
52+
53+
If `--input-dir` or `--input-file` is not set when calling `upload` the command will search for the deterministically
54+
created build directory in the temp folder and use the binaries found there.
55+
56+
The gRPC interface has been updated accordingly, `dryRun` is removed.
57+
58+
### Programmers can't be listed anymore using `burn-bootloader -P list`
59+
60+
The `-P` flag is used to select the programmer used to burn the bootloader on the specified board. Using `-P list` to
61+
list all the possible programmers for the current board was hackish.
62+
63+
This way has been removed in favour of `board details <fqbn> --list-programmers`.
64+
65+
### `lib install --git-url` and `--zip-file` must now be explicitly enabled
66+
67+
With the introduction of the `--git-url` and `--zip-file` flags the new config key `library.enable_unsafe_install` has
68+
been added to enable them.
69+
70+
This changes the ouput of the `config dump` command.

0 commit comments

Comments
 (0)