cfallin opened PR #13097 from cfallin:guest-debugging-docs to bytecodealliance:main:
<!--
Please make sure you include the following information:
If this work has been discussed elsewhere, please include a link to that
conversation. If it was discussed in an issue, just mention "issue #...".Explain why this change is needed. If the details are in an issue already,
this can be brief.Our development process is documented in the Wasmtime book:
https://docs.wasmtime.dev/contributing-development-process.htmlPlease ensure all communication follows the code of conduct:
https://github.com/bytecodealliance/wasmtime/blob/main/CODE_OF_CONDUCT.md
-->
cfallin requested fitzgen for a review on PR #13097.
cfallin requested wasmtime-default-reviewers for a review on PR #13097.
fitzgen created PR review comment:
Maybe also show setting breakpoints, stepping, and printing variables? Ideally with some kind of actual bug in the Wasm program? I guess this requires using an actual wasm program for the example as well, instead of
foo.wasm.So maybe we have (a) the short+concise steps of setting up guest debugging (flags to enable and all that) and then (b) the slightly longer-form (but it really needn't actually be long, just longer) walkthrough that shows a real program and actually using the guest debugging support to diagnose a (very simple and obvious) bug in it.
fitzgen created PR review comment:
- If building from source, use `cargo build --features gdbstub`.
fitzgen submitted PR review:
Doesn't necessarily have to be in this PR, but I think it would be fantastic to have two sections in this page:
- Using
lldbon the command line- Using VSCode as a graphical debugger
And then including screenshots in (2), similar to what we have for the guest profiler. Also (2) should probably come before (1) on the actual page.
Basically, I think this page could use some flash and pizazz (which screenshots and GUIs really help with) to show off all the great work you've done for guest debugging. As it is, this feels a little anti-climactic to me.
cfallin updated PR #13097.
cfallin commented on PR #13097:
Thanks! I'll go ahead and merge this as-is (since it more or less mirrors what we have for native debugging) to have something for 44.0; and we can work on a longer intro/tutorial, maybe including VS Code etc, off the critical path.
cfallin has enabled auto merge for PR #13097.
cfallin added PR #13097 Debugging: add docs to describe how to perform guest debugging. to the merge queue
cfallin merged PR #13097.
cfallin removed PR #13097 Debugging: add docs to describe how to perform guest debugging. from the merge queue
Last updated: May 03 2026 at 22:13 UTC