diff --git a/.github/workflows/ISSUE_TEMPLATE/bug_report.md b/.github/workflows/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/crates/spirv-std/README.md b/crates/spirv-std/README.md index fe399ca04e..9d2a8a1ca8 100644 --- a/crates/spirv-std/README.md +++ b/crates/spirv-std/README.md @@ -2,7 +2,7 @@ Core functions, traits, and more that make up a “standard library” for SPIR-V for use in [rust-gpu](https://github.com/rust-gpu/rust-gpu#readme). -This crate gives a `rust-gpu` shader access to the required `#![spirv(..)]` attribute, as well as povide all kinds of APIs that allows a shader to access GPU resources such as textures and buffers. Optionally, through the use of the `"glam"` feature, it includes some boilerplate trait implementations to make `glam` vector types compatible with these APIs. +This crate gives a `rust-gpu` shader access to the required `#![spirv(..)]` attribute, as well as provide all kinds of APIs that allows a shader to access GPU resources such as textures and buffers. Optionally, through the use of the `"glam"` feature, it includes some boilerplate trait implementations to make `glam` vector types compatible with these APIs. ## Example diff --git a/crates/spirv-std/macros/src/lib.rs b/crates/spirv-std/macros/src/lib.rs index c1f0d57ab9..671a15eb2c 100644 --- a/crates/spirv-std/macros/src/lib.rs +++ b/crates/spirv-std/macros/src/lib.rs @@ -113,7 +113,8 @@ use std::fmt::Write; /// when set the image format is unknown. /// Accepted values: `f32`, `f64`, `u8`, `u16`, `u32`, `u64`, `i8`, `i16`, `i32`, `i64`. /// - `format` — The image format of the image, mutually exclusive with `type`. -/// Accepted values: Snake case versions of [`ImageFormat`]. +/// Accepted values: Snake case versions of [`ImageFormat`] variants, e.g. `rgba32f`, +/// `rgba8_snorm`. /// - `sampled` — Whether it is known that the image will be used with a sampler. /// Accepted values: `true` or `false`. Default: `unknown`. /// - `multisampled` — Whether the image contains multisampled content. @@ -195,8 +196,6 @@ pub fn gpu_only(_attr: TokenStream, item: TokenStream) -> TokenStream { block, } = syn::parse_macro_input!(item as syn::ItemFn); - // FIXME(eddyb) this looks like a clippy false positive (`sig` is used below). - #[allow(clippy::redundant_clone)] let fn_name = sig.ident.clone(); let sig_cpu = syn::Signature { @@ -221,13 +220,13 @@ pub fn gpu_only(_attr: TokenStream, item: TokenStream) -> TokenStream { output.into() } -/// Print a formatted string with a newline using the debug printf extension. +/// Print a formatted string using the debug printf extension. /// /// Examples: /// /// ```rust,ignore -/// debug_printfln!("uv: %v2f", uv); -/// debug_printfln!("pos.x: %f, pos.z: %f, int: %i", pos.x, pos.z, int); +/// debug_printf!("uv: %v2f\n", uv); +/// debug_printf!("pos.x: %f, pos.z: %f, int: %i\n", pos.x, pos.z, int); /// ``` /// /// See for formatting rules. diff --git a/rust-toolchain.toml b/rust-toolchain.toml index 695cb49f92..663e76414b 100644 --- a/rust-toolchain.toml +++ b/rust-toolchain.toml @@ -3,5 +3,5 @@ channel = "nightly-2025-06-23" components = ["rust-src", "rustc-dev", "llvm-tools"] # commit_hash = be19eda0dc4c22c5cf5f1b48fd163acf9bd4b0a6 -# Whenever changing the nightly channel, update the commit hash above, and make -# sure to change `REQUIRED_TOOLCHAIN` in `crates/rustc_codegen_spirv/build.rs` also. +# Whenever changing the nightly channel, update the commit hash above, and +# change `REQUIRED_RUST_TOOLCHAIN` in `crates/rustc_codegen_spirv/build.rs` too. diff --git a/tests/compiletests/README.md b/tests/compiletests/README.md index 599f3b2899..1a48bcb438 100644 --- a/tests/compiletests/README.md +++ b/tests/compiletests/README.md @@ -59,7 +59,7 @@ full reference can be found in the ### Disassembly All disassembly will be dumped to stderr, which makes the testing framework compare it to the -contents of `path/to/test.rs.stdout`. +contents of `path/to/test.rs.stderr`. * `// compile-flags: -C llvm-args=--disassemble` disassemble the entire shader * `// compile-flags: -C llvm-args=--disassemble-globals` disassemble only globals and function declarations, excludes function contents