dnrops
/
burn
mirror of https://github.com/tracel-ai/burn.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fixed the debugger settings doc (#2223)

This commit is contained in:
tiruka 2024-09-02 05:37:56 +09:00 committed by GitHub
parent 09a15e7e15
commit ce2a50880b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
contributor-book/src/getting-started/configuring-your-editor.md
View File

@ -23,17 +23,8 @@ To use the debugger, follow these steps:
1. Open `Command Palette` with `Ctrl+Shift+P` or `F1` and type 1. Open `Command Palette` with `Ctrl+Shift+P` or `F1` and type
`LLDB: Generate Launch Configurations from Cargo.toml` then select it, this will generate a file `LLDB: Generate Launch Configurations from Cargo.toml` then select it, this will generate a file
that should be saved as `.vscode/launch.json`. that should be saved as `.vscode/launch.json`.
2. Select the configuration from the "run and debug" side panel, then select the target from the 2. Select the configuration from the "run and debug" side panel, then select the target from the list.
list. Since this repo has `debug = 0` in the root `Cargo.toml` to speed up compilation, you need replace it with `debug = true` in the root `Cargo.toml` when using a debugger and breakpoints with `launch.json` settings.
You may also want to enable debugging by creating a `.vscode/settings.json` file:
```
{
"rust-analyzer.runnables.extraEnv": {
"CARGO_PROFILE_DEV_DEBUG": true
}
}
```
since this repo has `debug = 0` in the root `Cargo.toml` to speed up compilation.
3. Now you can enable breakpoints on code through IDE then start debugging the library/binary you 3. Now you can enable breakpoints on code through IDE then start debugging the library/binary you
want, like in the following example: want, like in the following example: