Skip to content

Commit 166173b

Browse files
committed
Split crate docs
1 parent 6733379 commit 166173b

File tree

4 files changed

+15
-8
lines changed

4 files changed

+15
-8
lines changed

crates/cargo-gpu-cache/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "cargo-gpu-cache"
3-
description = "Generates shader .spv files from `rust-gpu` shader crates"
3+
description = "Builder of `rust-gpu` shader crates"
44
readme = "../../README.md"
55
version.workspace = true
66
edition.workspace = true

crates/cargo-gpu-cache/src/install.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,9 @@ pub struct Install {
7474
pub shader_crate: PathBuf,
7575

7676
#[expect(
77+
rustdoc::bare_urls,
7778
clippy::doc_markdown,
78-
reason = "The URL should appear literally like this. But Clippy wants a markdown clickable link"
79+
reason = "The URL should appear literally like this. But Clippy & rustdoc want a markdown clickable link"
7980
)]
8081
/// Source of `spirv-builder` dependency
8182
/// Eg: "https://github.com/Rust-GPU/rust-gpu"

crates/cargo-gpu-cache/src/lib.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
//! Rust GPU shader crate builder.
44
//!
5-
//! This program and library allows you to easily compile your rust-gpu shaders,
5+
//! This library allows you to easily compile your rust-gpu shaders,
66
//! without requiring you to fix your entire project to a specific toolchain.
77
//!
88
//! # How it works
99
//!
10-
//! This program primarily manages installations of `rustc_codegen_spirv`, the
10+
//! This library primarily manages installations of `rustc_codegen_spirv`, the
1111
//! codegen backend of rust-gpu to generate SPIR-V shader binaries. The codegen
1212
//! backend builds on internal, ever-changing interfaces of rustc, which requires
1313
//! fixing a version of rust-gpu to a specific version of the rustc compiler.
@@ -17,12 +17,12 @@
1717
//!
1818
//! We continue to use rust-gpu's `spirv_builder` crate to pass the many additional
1919
//! parameters required to configure rustc and our codegen backend, but provide you
20-
//! with a toolchain agnostic version that you may use from stable rustc. And a
21-
//! `cargo gpu` cmdline utility to simplify shader building even more.
20+
//! with a toolchain agnostic version that you may use from stable rustc.
21+
//! And a `cargo gpu` command line utility to simplify shader building even more.
2222
//!
2323
//! ## Where the binaries are
2424
//!
25-
//! We store our prebuild `rustc_spirv_builder` binaries in the default cache
25+
//! We store our prebuilt `rustc_spirv_builder` binaries in the default cache
2626
//! directory of your OS:
2727
//! * Windows: `C:/users/<user>/AppData/Local/rust-gpu`
2828
//! * Mac: `~/Library/Caches/rust-gpu`

crates/cargo-gpu/src/main.rs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
//! main executable of cargo gpu
1+
//! Command line tool for building Rust shaders using `rust-gpu`.
2+
//!
3+
//! This program allows you to easily compile your rust-gpu shaders,
4+
//! without requiring you to fix your entire project to a specific toolchain.
5+
//!
6+
//! For additional information see the [`cargo-gpu-cache`](cargo_gpu_cache) crate documentation.
7+
28
use cargo_gpu_cache::Cli;
39
use clap::Parser as _;
410

0 commit comments

Comments
 (0)