Skip to content

Commit 459aa77

Browse files
authored
Fix typos in description of debug attributes and fix Wiki link (#1212)
* Fix wiki link in CHANGELOG.md * Fix typos in the description of debug attributes
1 parent b87ff2c commit 459aa77

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ This is a major release. It has been in pre-release for quite a while and some o
162162
* You can also use **Microsoft Embedded Tools** and their RTOS views as we are now compatible with each other
163163
* Microsoft Embedded Tools also added compatibility for Cortex-Debug for their version of Peripheral Views/Registers. They also helped with integrating Cortex-Debug with MS built-in Hex-Editor. To use MS Peripheral View, use `svdPath` in launch.json. `svdFile` uses the SVD feature from Cortex-Debug. You can use both at the same time if you wish but you should typically use only one.
164164
* Fixed a long standing issue with OpenOCD RTT where there was no good way to know when to start the RTT. We can now poll until RTT is detected and enabled. See `rttConfig.rtt_start_retry` in your launch.json to control who the polling works.
165-
* Support for loading alternate symbol files instead of the `"executable"` using a new launch.json property `"symbolFiles"`. See the Wiki [documentation here](https://github.com/Marus/cortex-debug/wiki/Overview#debug-files). This is in addition to the already existing `"loadFiles"` which is used to customizing the programming of the device
165+
* Support for loading alternate symbol files instead of the `"executable"` using a new launch.json property `"symbolFiles"`. See the Wiki [documentation here](https://github.com/Marus/cortex-debug/wiki/Cortex-Debug-Under-the-hood#debug-files). This is in addition to the already existing `"loadFiles"` which is used to customizing the programming of the device
166166
* You can now use `breakAfterReset` and `runToEntryPoint` for an `attach` type launch configuration as well but they will only be used on a reset/restart.
167167
* For chained configuration, the parent can override properties of children and/or allow children to inherit from itself using `overrides` and `inherits`.
168168
* Of course, many issues fixed: thanks to the community with reporting them helping fixing them
@@ -196,7 +196,7 @@ This is a major release. It has been in pre-release for quite a while and some o
196196
# V1.5.1
197197

198198
## New features
199-
* Support for loading alternate symbol files instead of the `"executable"` using a new launch.json property `"symbolFiles"`. See the Wiki [documentation here](https://github.com/Marus/cortex-debug/wiki/Overview#debug-files). This is in addition to the already existing `"loadFiles"` which is used to customizing the programming of the device
199+
* Support for loading alternate symbol files instead of the `"executable"` using a new launch.json property `"symbolFiles"`. See the Wiki [documentation here](https://github.com/Marus/cortex-debug/wiki/Cortex-Debug-Under-the-hood#debug-files). This is in addition to the already existing `"loadFiles"` which is used to customizing the programming of the device
200200
* You can now use `breakAfterReset` and `runToEntryPoint` for an `attach` type launch configuration as well but they will only be used on a reset/restart.
201201
* For chained configuration, the parent can override properties of children and/or allow children to inherit from itself using `overrides` and `inherits`.
202202

debug_attributes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,8 @@ If the type is marked as `{...}` it means that it is a complex item can have mul
9898
| swoConfig<br>.swoEncoding | string | Both | BMP only: SWO encoding data used at the line level. Depends on the probe hardware, native (the original one) supports only Manchester (self-clocked, but slower rates) while most other platforms (e.g. ST-LINK with BMP firmware) support only UART (frequency/baud rate has to match to within ~2%). |
9999
| swoConfig<br>.swoFrequency | number | Both | SWO frequency in Hz. |
100100
| swoConfig<br>.swoPath | string | Both | Path name when source is "file" or "serial", device name regex match when source is "probe" for BMP. Typically a /path-name or a serial-port-name |
101-
| swoConfig<br>.swoPort | string | Both | When server is "external" && source is "socket", port to connect to. Format [host:]port. For BMP, specifies the regex match of the USB interface contianing raw SWO data. |
102-
| symbolFiles | object[] | Both | Array of ELF files to load symbols from instead of the executable file. Each item in the array cab be a string or an object. Program information is ignored (see `loadFiles`). Can be an empty list to specify none. If this property does not exist, then the executable is used for symbols |
101+
| swoConfig<br>.swoPort | string | Both | When server is "external" && source is "socket", port to connect to. Format [host:]port. For BMP, specifies the regex match of the USB interface containing raw SWO data. |
102+
| symbolFiles | object[] | Both | Array of ELF files to load symbols from instead of the executable file. Each item in the array can be a string or an object. Program information is ignored (see `loadFiles`). Can be an empty list to specify none. If this property does not exist, then the executable is used for symbols |
103103
| targetId | string &#124; number | Both | On BMP this is the ID number that should be passed to the attach command (defaults to 1); for PyOCD this is the target identifier (only needed for custom hardware) |
104104
| targetProcessor | number | Both | The processor you want to debug. Zero based integer index. Must be less than 'numberOfProcessors' |
105105
| toolchainPrefix | string | Both | This setting can be used to override the toolchainPrefix user setting for a particular launch configuration. Default = "arm-none-eabi" |

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -699,7 +699,7 @@
699699
"type": "string"
700700
},
701701
"symbolFiles": {
702-
"description": "Array of ELF files to load symbols from instead of the executable file. Each item in the array cab be a string or an object. Program information is ignored (see `loadFiles`). Can be an empty list to specify none. If this property does not exist, then the executable is used for symbols",
702+
"description": "Array of ELF files to load symbols from instead of the executable file. Each item in the array can be a string or an object. Program information is ignored (see `loadFiles`). Can be an empty list to specify none. If this property does not exist, then the executable is used for symbols",
703703
"type": "array",
704704
"items": {
705705
"type": [
@@ -1879,7 +1879,7 @@
18791879
"default": null
18801880
},
18811881
"symbolFiles": {
1882-
"description": "Array of ELF files to load symbols from instead of the executable file. Each item in the array cab be a string or an object. Program information is ignored (see `loadFiles`). Can be an empty list to specify none. If this property does not exist, then the executable is used for symbols",
1882+
"description": "Array of ELF files to load symbols from instead of the executable file. Each item in the array can be a string or an object. Program information is ignored (see `loadFiles`). Can be an empty list to specify none. If this property does not exist, then the executable is used for symbols",
18831883
"type": "array",
18841884
"items": {
18851885
"type": [
@@ -2613,7 +2613,7 @@
26132613
"swoPort": {
26142614
"type": "string",
26152615
"default": "",
2616-
"description": "When server is \"external\" && source is \"socket\", port to connect to. Format [host:]port. For BMP, specifies the regex match of the USB interface contianing raw SWO data."
2616+
"description": "When server is \"external\" && source is \"socket\", port to connect to. Format [host:]port. For BMP, specifies the regex match of the USB interface containing raw SWO data."
26172617
},
26182618
"decoders": {
26192619
"description": "SWO Decoder Configuration",

0 commit comments

Comments
 (0)