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

spirv: Drop stale "tracking SPIR-V major/minor version" from README #253

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

MarijnS95
Copy link
Collaborator

For #252, CC @tareksander

Since inheriting the spirv crate and dropping the spirv_headers crate in #204, and following up on a choice in #197 to no longer have the SPIR-V major/minor version in our crate version which disallows us from making any breaking changes to the crate, we reset the version to 0.1.0 and embedded the SPIR-V version via version metadata instead. This stale comment in the README was still indicating as such though, confusing users in e.g. #252 that our spirv crate was somehow exposing SPIR-V 1.3 (should have been 0.3 by that logic which is the current latest version). Remove it entirely.

Note also that since #225 / #226 our version metadata is no longer the SPIR-V version/revision but the Vulkan SDK tag that it was released with. The SPIR-V version isn't bumped often enough to match extensions in new SDK releases, making the SDK tag more indicative of the included API surface instead.

Specifically `rust-version = "1.58"` in the `autogen` module that
I added in #223 is weird, since any developers working on and/or
contributing to the repository should easily be able to run the latest
stable and take advantage of newer Rust features in `autogen` code.
@MarijnS95 MarijnS95 force-pushed the spirv-stale-version-docs branch from eb2c4f7 to 3f688c2 Compare December 28, 2024 16:26
Since inheriting the `spirv` crate and dropping the `spirv_headers`
crate in #204, and following up on a choice in #197 to no longer have
the SPIR-V major/minor version in our crate version which disallows us
from making any breaking changes to the crate, we reset the version to
`0.1.0` and embedded the SPIR-V version via _version metadata_ instead.
This stale comment in the README was still indicating as such though,
confusing users in e.g. #252 that our `spirv` crate was somehow exposing
SPIR-V 1.3 (should have been 0.3 by that logic which is the current
latest version).  Remove it entirely.

Note also that since #225 / #226 our version metadata is no longer the
SPIR-V version/revision but the Vulkan SDK tag that it was released
with.  The SPIR-V version isn't bumped often enough to match extensions
in new SDK releases, making the SDK tag more indicative of the included
API surface instead.
@MarijnS95 MarijnS95 force-pushed the spirv-stale-version-docs branch from 3f688c2 to 8a905f3 Compare December 28, 2024 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants