Skip to content

Commit 7d4baa9

Browse files
committed
[skip changelog] Update UPGRADING.md for 0.14.0
1 parent 4b3758b commit 7d4baa9

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

Diff for: docs/UPGRADING.md

+35-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,38 @@
22

33
Here you can find a list of migration guides to handle breaking changes between releases of the CLI.
44

5-
## Unreleased
5+
## 0.14.0
6+
7+
### Changes in `debug` command
8+
9+
Previously it was required:
10+
11+
- To provide a debug command line recipe in `platform.txt` like `tools.reciped-id.debug.pattern=.....` that will start a
12+
`gdb` session for the selected board.
13+
- To add a `debug.tool` definition in the `boards.txt` to recall that recipe, for example `myboard.debug.tool=recipe-id`
14+
15+
Now:
16+
17+
- Only the configuration needs to be supplied, the `arduino-cli` or the GUI tool will figure out how to call and setup
18+
the `gdb` session. An example of configuration is the following:
19+
20+
```
21+
debug.executable={build.path}/{build.project_name}.elf
22+
debug.toolchain=gcc
23+
debug.toolchain.path={runtime.tools.arm-none-eabi-gcc-7-2017q4.path}/bin/
24+
debug.toolchain.prefix=arm-none-eabi-
25+
debug.server=openocd
26+
debug.server.openocd.path={runtime.tools.openocd-0.10.0-arduino7.path}/bin/
27+
debug.server.openocd.scripts_dir={runtime.tools.openocd-0.10.0-arduino7.path}/share/openocd/scripts/
28+
debug.server.openocd.script={runtime.platform.path}/variants/{build.variant}/{build.openocdscript}
29+
```
30+
31+
The `debug.server.XXXX` subkeys are optional and also "free text", this means that the configuration may be extended as
32+
needed by the specific server. For now only `openocd` is supported. Anyway, if this change works, any other kind of
33+
server may be fairly easily added.
34+
35+
The `debug.xxx=yyy` definitions above may be supplied and overlayed in the usual ways:
36+
37+
- on `platform.txt`: definition here will be shared through all boards in the platform
38+
- on `boards.txt` as part of a board definition: they will override the global platform definitions
39+
- on `programmers.txt`: they will override the boards and global platform definitions if the programmer is selected

0 commit comments

Comments
 (0)