mirror of
https://github.com/bevyengine/bevy
synced 2024-09-20 14:32:06 +00:00
3a20462d3f
This obsoletes #1111 and #2445, since @ColonisationCaptain and @temhotaokeaha haven't replied to #2373. I believe that both of those PRs would be fine to keep, but they're even more fine to keep now :)
18 lines
1.2 KiB
Markdown
18 lines
1.2 KiB
Markdown
# Debugging
|
|
|
|
## Macro Debugging
|
|
|
|
* Print the final output of a macro using `cargo rustc --profile=check -- -Zunstable-options --pretty=expanded`
|
|
* Alternatively you could install and use [cargo expand](https://github.com/dtolnay/cargo-expand) which adds syntax highlighting to the terminal output.
|
|
* Additionally get pager by piping to `less` ( on Unix systems ): `cargo expand --color always | less -R`
|
|
* Print output during macro compilation using `eprintln!("hi");`
|
|
|
|
## WGPU Tracing
|
|
|
|
When a suspected wgpu error occurs, you should capture a wgpu trace so that Bevy and wgpu devs can debug using the [wgpu player tool](https://github.com/gfx-rs/wgpu/wiki/Debugging-wgpu-Applications#tracing-infrastructure).
|
|
|
|
To capture a wgpu trace:
|
|
|
|
1. Create a new `wgpu_trace` folder in the root of your cargo workspace
|
|
2. Add the "wgpu_trace" feature to the bevy crate. (ex: `cargo run --example features wgpu_trace`)
|
|
3. Zip up the wgpu_trace folder and attach it to the relevant issue. New wgpu issues should generally be created [in the wgpu repository](https://github.com/gfx-rs/wgpu). Please include the wgpu revision in your bug reports. You can find the revision in the `Cargo.lock` file in your workspace.
|