diff options
| author | Kieran Cawthray <kieranc@gmail.com> | 2022-09-05 22:03:56 +0200 |
|---|---|---|
| committer | Kieran Cawthray <kieranc@gmail.com> | 2022-09-05 22:03:56 +0200 |
| commit | 293340515812b15030b6497a3eed1b1b8fceadae (patch) | |
| tree | a46c96953676a756723477a363a5eedafbbd3dd1 /doc/buildWithVScode.md | |
| parent | 593ca2028d77c013fa4026a7183b7f66f2cca5ba (diff) | |
| parent | f53e75063b6ef618d65a1f287df52ba01c3351f5 (diff) | |
Merge remote-tracking branch 'upstream/develop' into pts-options
Diffstat (limited to 'doc/buildWithVScode.md')
| -rw-r--r-- | doc/buildWithVScode.md | 25 |
1 files changed, 10 insertions, 15 deletions
diff --git a/doc/buildWithVScode.md b/doc/buildWithVScode.md index 48b8923f..8e136511 100644 --- a/doc/buildWithVScode.md +++ b/doc/buildWithVScode.md @@ -26,27 +26,22 @@ We leverage a few VS Code extensions for ease of development. Cortex-Debug is only required for interactive debugging using VS Codes built in GDB support. - - ## VS Code/Docker DevContainer The .devcontainer folder contains the configuration and scripts for using a Docker dev container for building InfiniTime -Using the [Remote-Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension is recommended. It will handle configuring the Docker virtual machine and setting everything up. +Using the [Remote-Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension is recommended. It will handle configuring the Docker virtual machine and setting everything up. -More documentation is available in the [readme in .devcontainer](.devcontainer/readme.md) +More documentation is available in the [readme in .devcontainer](.devcontainer/readme.md) ### DevContainer on Ubuntu -To use the DevContainer configuration on Ubuntu based systems two changes need to be made: - -1. Modify the file ``.devcontainer/devcontainer.json`` and add the argument ``"--net=host"`` to the ``"runArgs"`` parameter making the line look like this: -`` "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined", "--net=host"], -`` -2. Modify the file ``.vscode/launch.json`` and change the argument of ``"gdbTarget"`` to ``"127.0.0.1:3333"``, making the line look like: -``"gdbTarget": "127.0.0.1:3333",`` -3. To start debugging launch openocd on your host system with the appropriate configuration, for example with a stlink-v2 the command is: -``openocd -f interface/stlink.cfg -f target/nrf52.cfg``. This launches openocd with the default ports ``3333``, ``4444`` and ``6666``. -4. In VsCode go to the Debug pane on the left of the screen and select the configuration ``Debug - Openocd docker Remote`` and hit the play button on the left. - +To use the DevContainer configuration on Ubuntu based systems two changes need to be made: +1. Modify the file `.devcontainer/devcontainer.json` and add the argument `"--net=host"` to the `"runArgs"` parameter making the line look like this: + `"runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined", "--net=host"],` +2. Modify the file `.vscode/launch.json` and change the argument of `"gdbTarget"` to `"127.0.0.1:3333"`, making the line look like: + `"gdbTarget": "127.0.0.1:3333",` +3. To start debugging launch openocd on your host system with the appropriate configuration, for example with a stlink-v2 the command is: + `openocd -f interface/stlink.cfg -f target/nrf52.cfg`. This launches openocd with the default ports `3333`, `4444` and `6666`. +4. In VsCode go to the Debug pane on the left of the screen and select the configuration `Debug - Openocd docker Remote` and hit the play button on the left. |