Skip to content

Commit

Permalink
Deprecate our Restart and use VSCode for the same
Browse files Browse the repository at this point in the history
  • Loading branch information
@haneefdm
haneefdm committed Jul 5, 2024
1 parent 5a2effe commit 6236742
Show file tree
Hide file tree
Showing 15 changed files with 163 additions and 96 deletions.
64 changes: 47 additions & 17 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"description": "If true, display variables in their natural format as specified by ARM. Hex otherwise."
},
"cortex-debug.liveWatchRefreshRate": {
"default": "300",
"default": 300,
"description": "GUI refresh frequency in milliseconds. Your sample rate can be much faster than refresh rate. VSCode UI cannot handle high refresh rates and your Live Watch window will look frozen. Do not recommend below 250ms as it will not be legible anyways. Anything below 200ms did not work at all for us",
"type": "number",
"multipleOf": 1,
Expand Down Expand Up @@ -136,6 +136,22 @@
],
"default": null,
"description": "This setting allows you to completely override the path/executable for the objdump executable. This is useful for cases where your objdump executable doesn't follow the standard <tuple>-objdump format - for example `objdump-multiarch`. This can be just the executable name (if on the system path) or the full path. The program 'nm' is also expected alongside"
},
"cortex-debug.internalDebugOptions": {
"description": "Internal debug options to debug this extension. These options must ideally be selected before you start VSCode",
"type": "object",
"properties": {
"file": {
"type": "string",
"default": "cortex-debug-log-${PID}.txt",
"description": "Pathname were debug output is stored. If empty or not-writable, no output is created. Use ${PID} in the file name to make it unique per a session"
},
"disassembly": {
"type": "boolean",
"default": false,
"description": "Enable disassembly debug"
}
}
}
}
},
Expand Down Expand Up @@ -558,43 +574,46 @@
"default": [],
"type": "array",
"items": "string",
"description": "Additional GDB Commands to be executed at the beginning of the restart sequence (after interrupting execution)."
"deprecated": true,
"description": "Deprecated: Restart is now handled by VSCode. Change to preResetCommands if you use the Reset button."
},
"postRestartCommands": {
"default": [],
"type": "array",
"items": "string",
"description": "Additional GDB Commands to be executed at the end of the restart sequence."
"deprecated": true,
"description": "Deprecated: Restart is now handled by VSCode. Change to postResetCommands if you use the Reset button."
},
"preResetCommands": {
"default": [],
"type": "array",
"items": "string",
"description": "Additional GDB Commands to be executed at the beginning of the reset sequence (after interrupting execution). When not defined this will have the same value of preRestartCommands."
"description": "Additional GDB Commands to be executed at the start of the reset sequence. When undefined the deprecated preRestartCommands is used."
},
"postResetCommands": {
"default": [],
"type": "array",
"items": "string",
"description": "Additional GDB Commands to be executed at the end of the reset sequence. When not defined this will have the same value of postRestartCommands."
"description": "Additional GDB Commands to be executed at the end of the reset sequence. When undefined the deprecated postRestartCommands is used."
},
"overrideAttachCommands": {
"default": null,
"type": "array",
"items": "string",
"description": "You can use this to property to override the commands that are normally executed as part of attaching to a running target. In most cases it is preferable to use preAttachCommands and postAttachCommands to customize the GDB attach sequence."
"description": "Override the commands that are normally executed as part of attaching to a running target. In most cases it is preferable to use preAttachCommands and postAttachCommands to customize the GDB attach sequence."
},
"overrideRestartCommands": {
"default": null,
"type": "array",
"items": "string",
"description": "You can use this to property to override the commands that are normally executed as part of restarting the target. In most cases it is preferable to use preRestartCommands and postRestartCommands to customize the GDB restart sequence."
"deprecated": true,
"description": "Deprecated: Restart is now handled by VSCode. Change to overrideResetCommands if you use the Reset button."
},
"overrideResetCommands": {
"default": null,
"type": "array",
"items": "string",
"description": "You can use this to property to override the commands that are normally executed as part of reset the target. When not defined this will have the same value of overrideRestartCommands. In most cases it is preferable to use preResetCommands and postResetCommands to customize the GDB reset sequence."
"description": "Override the commands that are normally executed as part of reset-ing the target. When undefined the deprecated overrideRestartCommands is used."
},
"postStartSessionCommands": {
"default": [],
Expand All @@ -606,7 +625,8 @@
"default": [],
"type": "array",
"items": "string",
"description": "Additional GDB Commands to be executed at the end of the re-start sequence, after a debug session has already started."
"deprecated": true,
"description": "Deprecated: Restart is now handled by VSCode and it is pretty much the same as Start"
},
"overrideGDBServerStartedRegex": {
"description": "You can supply a regular expression (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) in the configuration property to override the output from the GDB Server that is looked for to determine if the GDB Server has started. Under most circumstances this will not be necessary - but could be needed as a result of a change in the output of a GDB Server making it incompatible with cortex-debug. This property has no effect for bmp or external GDB Server types.",
Expand Down Expand Up @@ -1657,43 +1677,46 @@
"default": [],
"type": "array",
"items": "string",
"description": "Additional GDB Commands to be executed at the beginning of the restart sequence (after interrupting execution)."
"deprecated": true,
"description": "Deprecated: Restart is now handled by VSCode. Change to preResetCommands if you use the Reset button."
},
"postRestartCommands": {
"default": [],
"type": "array",
"items": "string",
"description": "Additional GDB Commands to be executed at the end of the restart sequence."
"deprecated": true,
"description": "Deprecated: Restart is now handled by VSCode. Change to postResetCommands if you use the Reset button."
},
"preResetCommands": {
"default": [],
"type": "array",
"items": "string",
"description": "Additional GDB Commands to be executed at the beginning of the reset sequence (after interrupting execution). When not defined this will have the same value of preRestartCommands."
"description": "Additional GDB Commands to be executed at the start of the reset sequence. When undefined the deprecated preRestartCommands is used."
},
"postResetCommands": {
"default": [],
"type": "array",
"items": "string",
"description": "Additional GDB Commands to be executed at the end of the reset sequence. When not defined this will have the same value of postRestartCommands."
"description": "Additional GDB Commands to be executed at the end of the reset sequence. When undefined the deprecated postRestartCommands is used."
},
"overrideLaunchCommands": {
"default": null,
"type": "array",
"items": "string",
"description": "You can use this to property to override the commands that are normally executed as part of flashing and launching the target. In most cases it is preferable to use preLaunchCommands and postLaunchCommands to customize the GDB launch sequence."
"description": "Override the commands that are normally executed as part of flashing and launching the target. In most cases it is preferable to use preLaunchCommands and postLaunchCommands to customize the GDB launch sequence."
},
"overrideRestartCommands": {
"default": null,
"type": "array",
"items": "string",
"description": "You can use this to property to override the commands that are normally executed as part of restarting the target. In most cases it is preferable to use preRestartCommands and postRestartCommands to customize the GDB restart sequence."
"deprecated": true,
"description": "Deprecated: Restart is now handled by VSCode. Change to overrideResetCommands if you use the Reset button."
},
"overrideResetCommands": {
"default": null,
"type": "array",
"items": "string",
"description": "You can use this to property to override the commands that are normally executed as part of reset the target. When not defined this will have the same value of overrideRestartCommands. In most cases it is preferable to use preResetCommands and postResetCommands to customize the GDB reset sequence."
"description": "Override the commands that are normally executed as part of reset-ing the target. When undefined the deprecated overrideRestartCommands is used if it exists."
},
"postStartSessionCommands": {
"default": [],
Expand All @@ -1705,7 +1728,14 @@
"default": [],
"type": "array",
"items": "string",
"description": "Additional GDB Commands to be executed at the end of the re-start sequence, after a debug session has already started."
"deprecated": true,
"description": "Deprecated: Restart is now handled by VSCode and it is the same as Start. If you are using the Reset button, use postResetSessionCommands instead"
},
"postResetSessionCommands": {
"default": [],
"type": "array",
"items": "string",
"description": "Additional GDB Commands to be executed at the end of the reset sequence"
},
"overrideGDBServerStartedRegex": {
"description": "You can supply a regular expression (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) in the configuration property to override the output from the GDB Server that is looked for to determine if the GDB Server has started. Under most circumstances this will not be necessary - but could be needed as a result of a change in the output of a GDB Server making it incompatible with cortex-debug. This property has no effect for bmp or external GDB Server types.",
Expand Down
Loading

0 comments on commit 6236742

Please sign in to comment.