Skip to content

Commit 6591578

Browse files
committed
Rename svdPath to definitionPath
1 parent b2c5a10 commit 6591578

4 files changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ Choose one of the following methods to specify your SVD file in your `launch.jso
1010

1111
### Use the CMSIS pack asset service
1212

13-
Set the `svdPath` configuration variable to a qualified pack reference in the form `<vendor>::<device family pack>@<version>` e.g.:
13+
Set the `definitionPath` configuration variable to a qualified pack reference in the form `<vendor>::<device family pack>@<version>` e.g.:
1414

1515
```json
1616
{
1717
...
18-
"svdPath": "NXP::K32L3A60_DFP@15.0.0"
18+
"definitionPath": "NXP::K32L3A60_DFP@15.0.0"
1919
...
2020
}
2121
```
@@ -25,7 +25,7 @@ If the pack supports multiple devices and/or processors, you will be prompted to
2525
```json
2626
{
2727
...
28-
"svdPath": "NXP::K32L3A60_DFP@15.0.0",
28+
"definitionPath": "NXP::K32L3A60_DFP@15.0.0",
2929
"deviceName": "K32L3A60VPJ1A",
3030
"processorName": "cm4"
3131
...
@@ -37,7 +37,7 @@ __TIP:__ The pack reference and device name can be automatically derived if you
3737
```json
3838
{
3939
...
40-
"svdPath": "${command:device-manager.getDevicePack}",
40+
"definitionPath": "${command:device-manager.getDevicePack}",
4141
"deviceName": "${command:device-manager.getDeviceName}"
4242
...
4343
}
@@ -61,12 +61,12 @@ You can obtain an SVD file from a [CMSIS pack](https://developer.arm.com/tools-a
6161

6262
Other vendors may ship SVD files when you install their software or device packs or you could write your own custom SVD file.
6363

64-
Once you have the SVD file, specify the location of it in your `launch.json` using the `svdPath` variable:
64+
Once you have the SVD file, specify the location of it in your `launch.json` using the `definitionPath` variable:
6565

6666
```json
6767
{
6868
...
69-
"svdPath": "${workspaceFolder}/STM32F103.svd"
69+
"definitionPath": "${workspaceFolder}/STM32F103.svd"
7070
...
7171
}
7272
```
@@ -77,6 +77,6 @@ All variable key names used to extract data from debug launch configurations can
7777

7878
The following list outlines the setting names and default values:
7979

80-
- `peripheral-inspector.svdPathConfig` - Debug configuration key to use to get the SVD path (default `svdPath`)
80+
- `peripheral-inspector.definitionPathConfig` - Debug configuration key to use to get the SVD path (default `definitionPath`)
8181
- `peripheral-inspector.deviceConfig` - Debug configuration key to use to get the device name (default: `deviceName`)
8282
- `peripheral-inspector.processorConfig` - Debug configuration key to use to get the processor name (default: `processorName`)

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -248,10 +248,10 @@
248248
"configuration": {
249249
"title": "Peripheral Inspector",
250250
"properties": {
251-
"peripheral-inspector.svdPathConfig": {
251+
"peripheral-inspector.definitionPathConfig": {
252252
"type": "string",
253-
"default": "svdPath",
254-
"description": "Debug configuration key to use to get the SVD path"
253+
"default": "definitionPath",
254+
"description": "Debug configuration key to use to get the path for the definition file"
255255
},
256256
"peripheral-inspector.deviceConfig": {
257257
"type": "string",

src/manifest.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
********************************************************************************/
77

88
export const PACKAGE_NAME = 'peripheral-inspector';
9-
export const CONFIG_SVD_PATH = 'svdPathConfig';
10-
export const DEFAULT_SVD_PATH = 'svdPath';
9+
export const CONFIG_SVD_PATH = 'definitionPathConfig';
10+
export const DEFAULT_SVD_PATH = 'definitionPath';
1111
export const CONFIG_DEVICE = 'deviceConfig';
1212
export const DEFAULT_DEVICE = 'deviceName';
1313
export const CONFIG_PROCESSOR = 'processorConfig';

src/views/peripheral.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ export class PeripheralTreeForSession extends PeripheralBaseNode {
250250
this.peripherials.sort(PeripheralNode.compare);
251251
// this.fireCb();
252252
} catch(e) {
253-
this.errMessage = `Unable to parse SVD file ${svdPath}: ${(e as Error).message}`;
253+
this.errMessage = `Unable to parse definition file ${svdPath}: ${(e as Error).message}`;
254254
vscode.debug.activeDebugConsole.appendLine(this.errMessage);
255255
if (vscode.debug.activeDebugConsole) {
256256
vscode.debug.activeDebugConsole.appendLine(this.errMessage);

0 commit comments

Comments
 (0)