-
Notifications
You must be signed in to change notification settings - Fork 62
docs(debugger): Updated the debugger configuration for Visual Studio Code #123
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
Updated the debugging documentation for VS Code as the prior configurations was outdated
Bromeon
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
src/toolchain/debugging.md
Outdated
| { | ||
| "name": "Debug Project (Godot 4)", | ||
| "type": "lldb", // type provided by CodeLLDB extension | ||
| "type": "lldb", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the comment inaccurate, or why removed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See #123 (comment)
src/toolchain/debugging.md
Outdated
| } | ||
| ``` | ||
|
|
||
| ```jsonc |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note that while it's technically more correct, jsonc isn't associated with a syntax highlighter in mdbook, so the reader experience is worse than with json.
You can render the page with mdbook serve --open to quickly test this for yourself 🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea, I quickly edited it in GitHubs Web Editor 🙃 I'll do it proper and run it locally, sorry for the holdup.
| "args": [ | ||
| "-w" | ||
| ], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also here, you removed the -e and all comments. I understand why -e might not be preferrable as default choice, but you could still leave it there, commented-out, so that people who want it can quickly learn about it.
I don't see why you removed the comment for -w, it's not necessarily obvious what this argument does.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Opening it as editor with -e does not keep the breakpoints for LLDB. At least I was unable to make it work and I found several other sharing that problem on the discord.
I forgot mentioning this in my original PR description and will add it now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
Apologies, I removed the comments because it was for myself and I copied over my configuration promptly, forgetting correctly merging the two. I will better consolidate it with the previous version. |
|
Note – I had issue with lldb in which I had to manually add In Zed I'm handling it by specifying: Oh, and remember about squashing commits later 😅 |
|
Changed to json instead of jsonc and added back comments. I also did a local squash rebase, but that seems to not have worked here ... my local git history looks good now, but seems it didn't transfer correctly. Anyhow, if the PR is still not satisfactory then please treat it as stale or close it as I'm currently short on time, sorry! |
Updated the debugging documentation for VS Code as the prior configurations was outdated
These where the previous issues of the example configuration
With the given changes these should no longer be a problem.
I would have loved to omit the tasks.json, but sadly its not possible to set a working directory for
cargo build(except for running when nightly channel)