Fix generating invalid YAML files #282
Merged
Conversation
This file contains 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
YAML 1.0 demands that the separator between a YAML directive and its value is a colon. This wasn't the case for the YAML files generated by spirv-reflect, as it used a space as separator instead. This resulted in tools parsing YAML stricly not being able to process the YAML files generated by spirv-reflect. Newer YAML versions demand a space as separator between YAML directive and its value instead. To fix this, this commit increases the YAML version to 1.1. This is done instead of replacing the separator to improve compatibility with tooling, as many tools don't support YAML 1.0 and require YAML 1.1 as minimal version.
|
|
spencer-lunarg
approved these changes
Oct 4, 2024
There was a problem hiding this comment.
@chaoticbob this seems fine with me, are you aware of any automated tools that were consuming these YAML that would break from this
|
been a week, going to merge this since in theory it was already broken pretending to be 1.0 doing 1.1 things |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
YAML 1.0 demands that the separator between a YAML directive and its value is a colon. This wasn't the case for the YAML files generated by spirv-reflect, as it used a space as separator instead. This resulted in tools parsing YAML stricly not being able to process the YAML files generated by spirv-reflect.
Newer YAML versions demand a space as separator between YAML directive and its value instead.
To fix this, this commit increases the YAML version to 1.1. This is done instead of replacing the separator to improve compatibility with tooling, as many tools don't support YAML 1.0 and require YAML 1.1 as minimal version (see the list of tools on https://yaml.org/).