From 3f688c2e84c68f25ac7e7c11b07490aec3e339ef Mon Sep 17 00:00:00 2001 From: Marijn Suijten Date: Tue, 5 Nov 2024 10:34:02 +0100 Subject: [PATCH] spirv: Drop stale "tracking SPIR-V major/minor version" from README 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. --- spirv/README.md | 9 --------- 1 file changed, 9 deletions(-) diff --git a/spirv/README.md b/spirv/README.md index 7f57598..8175367 100644 --- a/spirv/README.md +++ b/spirv/README.md @@ -21,15 +21,6 @@ First add to your `Cargo.toml`: spirv = "0.3.0" ``` -Version -------- - -Note that the major and minor version of this create is tracking the SPIR-V spec, -while the patch number is used for bugfixes for the crate itself. So version -`1.4.2` is tracking SPIR-V 1.4 but not necessarily revision 2. Major client APIs -like Vulkan/OpenCL pin to a specific major and minor version, regardless of the -revision. - Examples --------