Skip to content

Commit b2b9fba

Browse files
authored
[skip changelog] Remove outdated information re: debug config from platform spec (#1203)
Since the time the documentation for the initial experimental debugging configuration system was added to the Arduino Platform Specification, the system has changed significantly, resulting in some of the documentation no longer being applicable to the current version of Arduino CLI. This only removes the outdated information, leaving the parts that are still correct. The new debug system will be fully documented at a later time.
1 parent bf364db commit b2b9fba

File tree

1 file changed

+1
-12
lines changed

1 file changed

+1
-12
lines changed

Diff for: docs/platform-specification.md

+1-12
Original file line numberDiff line numberDiff line change
@@ -594,7 +594,6 @@ used for different purposes:
594594
- **program** a sketch to the target board using an external programmer
595595
- **erase** the target board's flash memory using an external programmer
596596
- burn a **bootloader** into the target board using an external programmer
597-
- **debug** a sketch
598597

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

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

812-
The **debug.tool** property specifies the tool ID of the tool to be used for debugging. A **debug.tool** property may be
813-
defined for each board in boards.txt.
814-
815811
The compiler optimization level that is appropriate for normal usage will often not provide a good experience while
816812
debugging. For this reason, it may be helpful to use different compiler flags when compiling a sketch for use with the
817813
debugger. The flags for use when compiling for debugging can be defined via the **compiler.optimization_flags.debug**
@@ -820,13 +816,6 @@ property, and those for normal use via the **compiler.optimization_flags.release
820816
IDE's **Sketch > Optimize for Debugging** setting or [`arduino-cli compile`](commands/arduino-cli_compile.md)'s
821817
`--optimize-for-debug` option.
822818

823-
The debug recipe is defined via **tools.TOOL_NAME.debug.pattern**. It can be built concatenating the following
824-
automatically generated properties:
825-
826-
- `{interpreter}`: the GDB command interpreter to use. It is configurable via
827-
[`arduino-cli debug --interpreter`](commands/arduino-cli_debug.md). This property was added in Arduino CLI 0.10.0 /
828-
Arduino Pro IDE v0.0.7-alpha.preview.
829-
830819
## Custom board options
831820

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

0 commit comments

Comments
 (0)