-
Notifications
You must be signed in to change notification settings - Fork 238
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'web-debug' into 'master'
[web] Added page on debugging with VS Code See merge request ogs/ogs!5103
- Loading branch information
Showing
6 changed files
with
58 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56 changes: 56 additions & 0 deletions
56
web/content/docs/devguide/advanced/vscode-debugging/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
+++ | ||
date = "2014-09-12T11:00:13+01:00" | ||
title = "Debugging in VS Code" | ||
author = "Lars Bilke" | ||
weight = 1062 | ||
|
||
[menu] | ||
[menu.devguide] | ||
parent = "advanced" | ||
+++ | ||
|
||
<div class="note"> | ||
<i class="far fa-exclamation-triangle"></i> This guide applies to Linux-only! | ||
</div> | ||
|
||
[Visual Studio Code](https://code.visualstudio.com/) is a powerful text editor which can be expanded to a full featured integrated development environment (IDE) with plugins. To debug a program make sure to install the [C/C++ Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-extension-pack) which includes support for CMake and debugging with `gdb`. | ||
|
||
Then in the editor: | ||
|
||
1. Open e.g. `ogs.cpp`. | ||
2. Set a [breakpoint](https://code.visualstudio.com/docs/editor/debugging#_breakpoints) in the first line of the `main()`-function (around line 58) by clicking on the left gutter in the editor window (a red dot marks the enabled breakpoint). | ||
3. Click on the `CMake`-sidebar. | ||
4. Make sure that `debug` is the active configure and build preset. | ||
5. Click the `Build`-button in the status bar. | ||
6. Click the bug icon in the status bar. | ||
|
||
![Initiate debug session](vscode-debugging-1.png) | ||
|
||
After some seconds the debugger starts and halts at the specified breakpoint indicated y the yellow marker around the breakpoint and line. You can now step into or over statements with debugger controls at the top of the window: | ||
|
||
![Running debug session](vscode-debugging-2.png) | ||
|
||
To debug with specific arguments to `ogs`, e.g. for setting a `.prj`-file: | ||
|
||
1. Click on the `Debug`-sidebar. | ||
2. Click on `create a launch.json file`. | ||
3. Click `Add Configuration`. | ||
4. Select `C/C++: (gdb) Launch` | ||
|
||
![Setup a launch.json file](vscode-debugging-3.png) | ||
|
||
Edit the file e.g. like this: | ||
|
||
```json | ||
"program": "${workspaceFolder}/../build/debug/bin/ogs", | ||
"args": ["${workspaceFolder}/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/CO2Injection/cl.prj"], | ||
"cwd": "${workspaceFolder}/../build/debug/_out", | ||
``` | ||
|
||
This sets the program to debug to the `ogs`-binary in the debug build folder, sets a specific `.prj`-file to run and sets the working directory (output folder) to some `_out`-subfolder in the build directory. | ||
|
||
You can also give the debug configuration some meaningful name, e.g. `"name": "Debug cl.prj",` which results in a new button in the status bar: | ||
|
||
![Debug button](vscode-debugging-4.png) | ||
|
||
Click on it to start the debug session. |
Binary file added
BIN
+305 KB
web/content/docs/devguide/advanced/vscode-debugging/vscode-debugging-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+102 KB
web/content/docs/devguide/advanced/vscode-debugging/vscode-debugging-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+156 KB
web/content/docs/devguide/advanced/vscode-debugging/vscode-debugging-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+3.07 KB
web/content/docs/devguide/advanced/vscode-debugging/vscode-debugging-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.