Skip to content

[skip changelog] Remove outdated information re: debug system from platform spec #1203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 1, 2021
Merged

[skip changelog] Remove outdated information re: debug system from platform spec #1203

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 1 addition & 12 deletions docs/platform-specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -594,7 +594,6 @@ used for different purposes:
- **program** a sketch to the target board using an external programmer
- **erase** the target board's flash memory using an external programmer
- burn a **bootloader** into the target board using an external programmer
- **debug** a sketch

Each action has its own recipe and its configuration is done through a set of properties having key starting with
**tools** prefix followed by the tool ID and the action:
Expand Down Expand Up @@ -806,12 +805,9 @@ platform's platform.txt is done as usual.
Starting from Arduino CLI 0.9.0 / Arduino Pro IDE v0.0.5-alpha.preview, sketch debugging support is available for
platforms.

The debug action is triggered when the user clicks **Debug > Start Debugging** in the Arduino Pro IDE or runs the
The debug action is triggered when the user clicks the Debug button in the Arduino Pro IDE or runs the
[`arduino-cli debug`](commands/arduino-cli_debug.md) command.

The **debug.tool** property specifies the tool ID of the tool to be used for debugging. A **debug.tool** property may be
defined for each board in boards.txt.

The compiler optimization level that is appropriate for normal usage will often not provide a good experience while
debugging. For this reason, it may be helpful to use different compiler flags when compiling a sketch for use with the
debugger. The flags for use when compiling for debugging can be defined via the **compiler.optimization_flags.debug**
Expand All @@ -820,13 +816,6 @@ property, and those for normal use via the **compiler.optimization_flags.release
IDE's **Sketch > Optimize for Debugging** setting or [`arduino-cli compile`](commands/arduino-cli_compile.md)'s
`--optimize-for-debug` option.

The debug recipe is defined via **tools.TOOL_NAME.debug.pattern**. It can be built concatenating the following
automatically generated properties:

- `{interpreter}`: the GDB command interpreter to use. It is configurable via
[`arduino-cli debug --interpreter`](commands/arduino-cli_debug.md). This property was added in Arduino CLI 0.10.0 /
Arduino Pro IDE v0.0.7-alpha.preview.

## Custom board options

It can sometimes be useful to provide user selectable configuration options for a specific board. For example, a board
Expand Down