Rust-GPU / Rust-GPU/rust-gpu

[Migrated] Document resolver = "2" effective requirement for rust-gpu

Open
#90 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
3.4k
Forks
125
PR merge metrics
No merged PRs in 30d

Description

Issue automatically imported from old repo: https://github.com/EmbarkStudios/rust-gpu/issues/1022
Old labels: t: bug
Originally creatd by Firestar99 on 2023-04-03T10:47:39Z


Add official documentation that one should have

[workspace]
resolver = "2"

in their root cargo.toml to make sure dependencies are resolved correctly and that crates compiled with different features on native and spirv don't get merged into one feature set.

An example can be num-traits which compiles with features default,std on native and libm on spirv target.

For a practical example see the issue below:
https://github.com/EmbarkStudios/rust-gpu/issues/986

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the practical example in issue 986, then inspect the project's documentation and root Cargo.toml guidance. Add official guidance showing [workspace] resolver = "2" and explain that it prevents native and SPIR-V feature sets from being merged; done means the resolver requirement and num-traits example are documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.