You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/debugging.md
+17-3Lines changed: 17 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
This article on debugging is under construction. It refers to products in private beta, and also uses techniques that could expose your internet network to external attack. Care should be taken when following the steps below.
4
4
5
-
## Install Open OCD
5
+
## Install OpenOCD
6
6
7
7
1. Install the relevant driver for the devkits on chip debugger:
8
8
|Devkit |Driver |
@@ -17,6 +17,7 @@ This article on debugging is under construction. It refers to products in privat
17
17
You can choose to develop locally or develop in [Codespaces](https://github.com/features/codespaces).
18
18
19
19
* Developing locally requires the installation of the build/debug tools on your local machine to build the application.
20
+
* Develop locally in a Docker container. The development envrionment will be built automatically on your local mahcine.
20
21
* Developing in Codespaces doesn't require additional installation, however it requires early access to the Codespaces beta and also to expose a port on your computer the public internet.
21
22
22
23
### Setup Local Development
@@ -28,10 +29,23 @@ You can choose to develop locally or develop in [Codespaces](https://github.com/
28
29
1. Open Visual Studio Code and install the required extensions:
1. From the Command Palette (F1), choose "Remote-Containers: Open Folder in Container", and select the root folder of the cloned repository to build the Docker contains and start debugging
48
+
35
49
### Setup Codespaces Development
36
50
37
51
1. Go to the [Getting Started GitHub repository](https://github.com/azure-rtos/getting-started).
@@ -48,12 +62,12 @@ You can choose to develop locally or develop in [Codespaces](https://github.com/
1. Select "Add a Folder to your Workspace...", and choose the folder for the devkit of your choice.
52
-
> For example: choose the "STMicroelectronics/STM32L4_L4+" folder for the B-L475-IOT01 devkit.
65
+
1. Open the VSCode workspace in the directory for the devkit you would like to debug. For example the STM32L4 devkit workspace is "STMicroelectronics/STM32L4_L4+/STM32L4plus.code-workspace".
53
66
54
67
1. Build the application by pressing "F7"
55
68
1. Choose the "ARM GCC Cortex" CMake kit when prompted
56
69
57
70
1. Start the debugger by pressing "F5".
58
71
1. For debugging locally, use "localhost:3333" for the OpenOCD hostname.
72
+
1. For debugging from a local Docker image, use "host.docker.internal:3333".
59
73
1. For debugging via Codespaces, specify {PUBLIC_IP_ADDRESS}:3333
0 commit comments