Skip to content

Commit c4327a9

Browse files
authored
0.3.1 Release Preparations (#305)
* fix image links in README * version bumps and changelog --------- Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
1 parent 092d840 commit c4327a9

File tree

3 files changed

+38
-27
lines changed

3 files changed

+38
-27
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Change Log
22

3+
## 0.3.1
4+
5+
- Fixed image links in [README](https://marketplace.visualstudio.com/items?itemName=Arm.vscode-cmsis-debugger).
6+
37
## 0.3.0
48

59
- Switches away from `pre-release` distribution channel. Extension remains at `preview` status.

README.md

Lines changed: 33 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -84,18 +84,23 @@ your debug configuration's `target`>`server` setting to contain the full path to
8484
There are two ways to start a debug session:
8585

8686
1. If you have installed the CMSIS Solution extension, in the **CMSIS view**
87-
![CMSIS view](./images/cmsis-view-icon.png), click on the **Debug** icon
88-
![Debug icon in the CMSIS view](./images/debug-icon.png). Depending on the number of configurations in your
87+
![CMSIS view](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/cmsis-view-icon.png),
88+
click on the **Debug** icon
89+
![Debug icon in the CMSIS view](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/debug-icon.png).
90+
Depending on the number of configurations in your
8991
`launch.json` file, you will be asked to select a configuration for the debug session.
9092

91-
2. In the **Run and debug view** ![Run and debug view](./images/run-debug-view-icon.png), click the **Play** icon
92-
next to the selected debug connection ![Play button](./images/play-debug-button.png). The debug starts with the
93-
selected configuration.
93+
2. In the **Run and debug view**
94+
![Run and debug view](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/run-debug-view-icon.png),
95+
click the **Play** icon
96+
next to the selected debug connection
97+
![Play button](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/play-debug-button.png).
98+
The debug starts with the selected configuration.
9499

95100
The debugger loads the application program and executes the startup code. When program execution stops (by default at
96101
`main`), the source code opens at the next executable statement which is marked with a yellow arrow in the editor:
97102

98-
![Execution stopped at main](./images/stop-at-main.png)
103+
![Execution stopped at main](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/stop-at-main.png)
99104

100105
Most editor features are available in debug mode. For example, developers can use the Find command and can correct program
101106
errors.
@@ -104,15 +109,17 @@ errors.
104109

105110
If you do not wish to enter a debug session, you can issue a flash download only, followed by a reset of the device.
106111

107-
In the **CMSIS view** ![CMSIS view](./images/cmsis-view-icon.png), click on the **Run** icon
108-
![Run icon in the CMSIS view](./images/run-icon.png).
112+
In the **CMSIS view** ![CMSIS view](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/cmsis-view-icon.png),
113+
click on the **Run** icon
114+
![Run icon in the CMSIS view](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/run-icon.png).
109115

110116
## Run and Debug view
111117

112-
![Run and Debug view](./images/run-debug-view.png)
118+
![Run and Debug view](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/run-debug-view.png)
113119

114-
The **Run and debug view** ![Run and debug view](./images/run-debug-view-icon.png) differs from the other views in the
115-
following aspects:
120+
The **Run and debug view**
121+
![Run and debug view](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/run-debug-view-icon.png)
122+
differs from the other views in the following aspects:
116123

117124
- [Debug toolbar](#debug-toolbar) is available.
118125

@@ -144,7 +151,7 @@ Once a debug session starts, the **Debug toolbar** appears at the top of the win
144151
control the flow of the debug session, such as stepping through code, pausing execution, and stopping the debug
145152
session.
146153

147-
![Debug toolbar](./images/debug-toolbar.png)
154+
![Debug toolbar](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/debug-toolbar.png)
148155

149156
The following table describes the actions available in the debug toolbar:
150157

@@ -168,7 +175,7 @@ During a debugging session, you can inspect variables, expressions, and register
168175
relative to the selected stack frame in the **CALL STACK section**. In case of multi-core, registers are relative to
169176
the core that you are debugging.
170177

171-
![VARIABLES section](./images/VARIABLES-section.png)
178+
![VARIABLES section](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/VARIABLES-section.png)
172179

173180
To change the value of a variable during the debugging session, right-click on the variable in the
174181
**VARIABLES section** and select **Set Value**.
@@ -179,20 +186,20 @@ iexpression to access the variable. You can then use this expression in the [**W
179186
To filter variables by their name or value, use the Alt/Opt + Ctrl/Cmd + F keyboard shortcut while the focus is on the
180187
**VARIABLES section**, and type a search term.
181188

182-
![Searching in VARIABLES section](./images/search-VARIABLES.png)
189+
![Searching in VARIABLES section](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/search-VARIABLES.png)
183190

184191
### WATCH section
185192

186193
Variables and expressions can also be evaluated and watched in the Run and Debug view's WATCH section.
187194

188-
![WATCH section](./images/WATCH-section.png)
195+
![WATCH section](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/WATCH-section.png)
189196

190197
### CALL STACK section
191198

192199
The **CALL STACK** sections shows objects that are currently on stack. Threads are shown for applications
193200
that use an RTOS. Each object is associated to its location or value, and type.
194201

195-
![CALL STACK section](./images/call-stack-section.png)
202+
![CALL STACK section](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/call-stack-section.png)
196203

197204
The window content is updated automatically whenever program execution stops.
198205

@@ -218,12 +225,12 @@ To set or unset a breakpoint, click on the editor margin or use **F9** on the cu
218225
- When a debugging session starts, breakpoints that can't be registered with the debugger change to a gray hollow
219226
circle. The same might happen if the source is edited while a debug session without live-edit support is running.
220227

221-
![Breakpoint in the edirot margin](./images/bkpt-in-editor-margin.png)
228+
![Breakpoint in the edirot margin](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/bkpt-in-editor-margin.png)
222229

223230
For more control of your breakpoints, use the Run and Debug view's **BREAKPOINTS section**. This section lists all
224231
breakpoints in your code and provides extra actions to manage them.
225232

226-
![BREAKPOINTS section](./images/breakpoints-section.png)
233+
![BREAKPOINTS section](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/breakpoints-section.png)
227234

228235
#### Breakpoint types
229236

@@ -248,7 +255,7 @@ To add a conditional breakpoint:
248255

249256
- Choose the type of condition you want to set (expression, hit count, or wait for breakpoint).
250257

251-
![Creating a conditional breakpoint](./images/conditional-bkpt.gif)
258+
![Creating a conditional breakpoint](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/conditional-bkpt.gif)
252259

253260
To add a condition to an existing breakpoint:
254261

@@ -269,7 +276,7 @@ be useful when diagnosing failure cases in code that happen only after a certain
269276
Triggered breakpoints can be set by right-clicking on the glyph margin, selecting **Add Triggered Breakpoint**, and
270277
then choosing which other breakpoint enables the breakpoint.
271278

272-
![Creating a triggered breakpoint](./images/triggered-bkpt.gif)
279+
![Creating a triggered breakpoint](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/triggered-bkpt.gif)
273280

274281
##### Inline breakpoints
275282

@@ -307,7 +314,7 @@ evaluated within curly braces ('{}').
307314
To add a logpoint, right-click in the editor left margin and select Add Logpoint, or use the
308315
**Debug: Add Logpoint...** command in the Command Palette (**Ctrl/Cmd + Shift + p**).
309316

310-
![Creating a logpoint](./images/create-logpoint.gif)
317+
![Creating a logpoint](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/create-logpoint.gif)
311318

312319
Just like regular breakpoints, logpoints can be enabled or disabled and can also be controlled by a condition
313320
and/or hit count.
@@ -316,7 +323,7 @@ and/or hit count.
316323

317324
The Eclipse CDT Cloud **Periperhal Inspector** is a standalone SVD Viewer extension.
318325

319-
![Peripheral Inspector](./images/peripheral-inspector.png)
326+
![Peripheral Inspector](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/peripheral-inspector.png)
320327

321328
For more information, refer to the
322329
[Peripheral Inspector GitHub repository](https://github.com/eclipse-cdt-cloud/vscode-peripheral-inspector).
@@ -326,7 +333,7 @@ For more information, refer to the
326333
The Eclipse CDT Cloud **Memory Inspector** provides a powerful and configurable memory viewer that works with
327334
debug adapters.
328335

329-
![Memory Inspector](./images/memory-inspector.png)
336+
![Memory Inspector](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/memory-inspector.png)
330337

331338
It features:
332339

@@ -362,7 +369,7 @@ To open the **Disassembly View**:
362369
- press **Ctrl/Cmd + Shift + p** and select "Open Disassembly View" or
363370
- Right-click an item in the [**CALL STACK section**](#call-stack-section) and select "Open Disassembly View"
364371

365-
![Disassembly View](./images/disassembly-view.png)
372+
![Disassembly View](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/disassembly-view.png)
366373

367374
### Debug Console
368375

@@ -384,7 +391,7 @@ closing of quotes, and other language features.
384391
The following example shows how to check the currently set breakpoints with the `> info break` command. Afterwards, the
385392
application is run with the `> continue` command.
386393

387-
![Entering GDB commands in the Debug Console REPL](./images/entering_gdb_commands.gif)
394+
![Entering GDB commands in the Debug Console REPL](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/entering_gdb_commands.gif)
388395

389396
## Extension Functionality
390397

@@ -554,7 +561,7 @@ Make sure to build your application ELF file with DWARF version 5 debug informat
554561

555562
When starting a debug session, you might see this error:
556563

557-
![Remote communication error](./images/remote_comms_err.png)
564+
![Remote communication error](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/remote_comms_err.png)
558565

559566
**Possible reason**: A running instance of pyOCD
560567

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "vscode-cmsis-debugger",
33
"displayName": "Arm CMSIS Debugger",
44
"description": "Run and debug embedded and IoT projects on Arm Cortex-M single or multi core devices. Connects via pyOCD to CMSIS-DAP or other GDB servers.",
5-
"version": "0.3.0",
5+
"version": "0.3.1",
66
"preview": true,
77
"publisher": "Arm",
88
"author": "Jens Reinecke <jens.reinecke@arm.com>",

0 commit comments

Comments
 (0)