Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ignore and no_run to get cargo test to pass. #1101

Merged
merged 3 commits into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,10 @@ jobs:
if: ${{ matrix.target != 'aarch64-linux-android' }}
run: cargo run -p compiletests --release --no-default-features --features "use-installed-tools" -- --target-env vulkan1.1,vulkan1.2,spv1.3

- name: workspace test
if: ${{ matrix.target != 'aarch64-linux-android' }}
run: cargo test --release

# Examples
- name: cargo check examples
if: ${{ matrix.target != 'aarch64-linux-android' }}
Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Changed 🛠
- [PR#1101](https://github.com/EmbarkStudios/rust-gpu/pull/1101) Add `ignore` and `no_run` to documentation to make `cargo test` pass.
- [PR#1112](https://github.com/EmbarkStudios/rust-gpu/pull/1112) updated wgpu and winit in example runners
- [PR#1100](https://github.com/EmbarkStudios/rust-gpu/pull/1100) updated toolchain to `nightly-2023-09-30`
- [PR#1091](https://github.com/EmbarkStudios/rust-gpu/pull/1091) updated toolchain to `nightly-2023-08-29`
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ However, many things aren't implemented yet. That means that while being technic

![Sky shader](docs/assets/sky.jpg)

```rust
```rust,no_run
use glam::{Vec3, Vec4, vec2, vec3};

#[spirv(fragment)]
Expand Down
4 changes: 2 additions & 2 deletions crates/spirv-builder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ It takes care of pulling in the `SPIR-V` backend for Rust, `rustc_codegen_spirv`

## Example

```rust
```rust,no_run
use spirv_builder::{MetadataPrintout, SpirvBuilder};

fn main() -> Result<(), Box<dyn std::error::Error>> {
Expand All @@ -23,7 +23,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {

This example will build a shader crate called `my_shaders`. You typically insert this code in your crate's `build.rs` that requires the shader binary. The path to the shader module's binary will be set in the `my_shaders.spv` environment variable, which you can include in your project using something along the lines of:

```rust
```rust,ignore
const SHADER: &[u8] = include_bytes!(env!("my_shaders.spv"));
```

Expand Down
2 changes: 1 addition & 1 deletion crates/spirv-std/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This crate gives a `rust-gpu` shader access to the required `#![spirv(..)]` attr

Here is a small excerpt to see what a shader would look like. See [source][source] for full details of the shader that generates above image.

```rust,no_run
```rust,ignore
use spirv_std::spirv;
use glam::{Vec3, Vec4, vec2, vec3};

Expand Down
Loading