Skip to content

Commit f82718c

Browse files
authored
Remove documentation of automatically inserted launch config settings (#341)
* remove automatically inserted settings from README --------- Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
1 parent fbf3776 commit f82718c

1 file changed

Lines changed: 3 additions & 27 deletions

File tree

README.md

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
# Arm CMSIS Debugger
66

7-
87
The Arm® CMSIS Debugger extension pack is a comprehensive debug platform for Arm Cortex-M processor-based devices that uses the GDB/MI protocol.
98

109
- Supports single and multi-core processor systems.
@@ -277,42 +276,19 @@ The [Serial Monitor](https://learn.microsoft.com/en-us/cpp/embedded/serial-monit
277276

278277
## Extension Functionality
279278

280-
This extension contributes additional functionality to work seamlessly with other extensions.
279+
This extension adds functionality to work seamlessly with other extensions.
281280

282281
- A [debug configuration provider](https://code.visualstudio.com/api/references/vscode-api#DebugConfigurationProvider)
283282
for the type `gdbtarget` which comes with the [CDT GDB Debug Adapter Extension](https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.cdt-gdb-vscode).
284-
This provider automatically fills in default values for known remote GDB servers when launching a debug session.
283+
This provider manages the use of tools shipped with the extension:
284+
- If option `target`>`server` is set to `pyocd`, then it expands to the absolute path of the built-in pyOCD distribution.
285285
- CMSIS specific _launch_ configuration items for the `*` debugger type, i.e. visible for all debugger types.
286286
It depends on the actually used debug adapter type if this information is known and utilized.
287287

288-
### Debug Configuration Provider
289-
290-
The extension contributes a debug configuration provider which automatically fills gaps in a `gdbtarget`
291-
debug launch configuration on debug launch. The exact functionality depends on the used `target`>`server`
292-
value.
293-
294-
#### pyOCD
295-
296-
- If option `target`>`server` is set to `pyocd`, then it expands to the absolute path of
297-
the built-in pyOCD distribution.
298-
- If option `target`>`server` contains `pyocd`, then it extends the `target`>`serverParameters` list
299-
of `pyocd` command line arguments:
300-
- Prepends `gdbserver` if not present.
301-
- Appends `--port <gdbserver_port>` if the `target`>`port` setting is set, where `<gdbserver_port>` gets
302-
that port setting's value.
303-
- Appends `--cbuild-run` and the corresponding `cbuildRunFile` path if `cmsis`>`cbuildRunFile` is set.
304-
305288
> 📝 **Note:**
306289
> The built-in version of pyOCD supports the command line option `--cbuild-run` which isn't available
307290
> in releases outside this extension.
308291
309-
#### J-LINK
310-
311-
- If option `target`>`server` contains `JLinkGDBServer` or `JLinkGDBServerCL`, then it extends the
312-
`target`>`serverParameters` list of `JLinkGDBServer`/`JLinkGDBServerCL` command line arguments:
313-
- Appends `--port <gdbserver_port>` if the `target`>`port` setting is set, where `<gdbserver_port>` gets that
314-
port setting's value.
315-
316292
## Known Limitations and Workarounds
317293

318294
### pyOCD fails to load `*.cbuild-run.yml` in the default configuration

0 commit comments

Comments
 (0)