spirv: improve documentation detailing SPIR-V specification version#276
Open
ickk wants to merge 1 commit into
Open
spirv: improve documentation detailing SPIR-V specification version#276ickk wants to merge 1 commit into
ickk wants to merge 1 commit into
Conversation
autogen/header now exposes the SPIR-V specification version as literals via macros. The literals are then used by both the version constants, as well as the crate documentation using `#[doc]` attributes. Clarifies that the crate's version metadata refers to the git-tag of the SPIR-V Headers.
ickk
force-pushed
the
headers-version-docs
branch
from
5b54cc5 to
c9e7ed8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I was a little bit confused when trying to understand what version of the spir-v specification the
spirvcrates corresponds to.This patch includes the SPIR-V specification version in the
spirvcrate documentation explicitly, and further clarifies that the version-metadata corresponds to the git tag of the SPIRV-HEADERS repository.