From a1cfa7f336e4dbc9f65f6c8a091e9aa5a0de91fe Mon Sep 17 00:00:00 2001 From: MichiRecRoom <1008889+LikeLakers2@users.noreply.github.com> Date: Wed, 21 Aug 2024 00:36:42 -0400 Subject: [PATCH] Make the WGPU Tracing guide a little more concise --- docs/debugging.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/debugging.md b/docs/debugging.md index 3c9095b937a54..60ce21b918b97 100644 --- a/docs/debugging.md +++ b/docs/debugging.md @@ -17,7 +17,8 @@ To capture a wgpu trace: 2. Pass the path to the folder you created for your wgpu trace to `bevy_render::RenderPlugin`, using the `render_creation` field. * If you're manually creating the renderer resources, pass the path to wgpu when creating the `RenderDevice` and `RenderQueue`. * Otherwise, pass the path to Bevy via the `trace_path` field in `bevy_render::settings::WgpuSettings`. -3. Enable wgpu's trace feature and run your application - 1. Add `wgpu = "*"` to your Cargo.toml (this is effectively saying it can be *any* version of the wgpu crate, so it will not try to pull in a different version of wgpu than what is already pulled in by Bevy). - 2. Execute `cargo run --features wgpu/trace`. -4. Zip up the 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. +3. Add `wgpu = { version = "*", features = ["trace"]}` to your Cargo.toml. + * `version = "*"` tells Rust that this can be *any* version of the wgpu crate, so it will not try to pull in a different version of wgpu than what is already pulled in by Bevy. +4. Compile and run your application, performing any in-app actions necessary to replicate the wgpu error. + +Once you've captured a wgpu trace, zip up the 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.