bevy/docs/debugging.md

# 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.
add texture to frag shader. fix weird macro name collision bug 2020-02-19 04:26:02 +00:00			`# Debugging`

			`## Macro Debugging`

Add wgpu trace docs 2020-08-16 08:21:37 +00:00			* 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:`
Documenting small things here and there.. (#706) Documenting small things here and there.. 2020-10-21 22:57:03 +00:00
add more tracing docs 2020-08-16 08:26:42 +00:00			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`)
Useful changes with relicensing benefits (#2497) 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 :) 2021-07-17 21:59:31 +00:00			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.