generator: Print vk-parse errors when they're encountered
#930
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
Ralith
approved these changes
Aug 7, 2024
Some upstream `vk.xml` changes are causing failures on missing registry children later on in our generator code. These are complicated to debug, unless we print the errors that `vk-parse` already reports. In this debug case it was clarifying that some new and unknown elements upstream are the reason for high-level registry elements to not be parsable.
MarijnS95
force-pushed
the
print-vk-parse-errors
branch
from
986bb28
to
ac3d1a9
Compare
MarijnS95
added a commit
that referenced
this pull request
Nov 13, 2024
When `vk-parse` encounters XML parsing errors (e.g. on unknown attributes or elements) it skips the element and emits an error in a list of errors that are returned to the caller. We were originally never checking these leading to hard-to-debug issues, but eventually started asserting on this list being empty or otherwise panicking in #930. Since `ash`'s generator is used in Khronos' upstream CI (in a fallible yet warning way), any new attribute would cause the generator to fail and subsequently require updates to `vk-parse` and `ash` before their CI is no longer flagged as "succeeded with warnings". "Solve" this by once again allowing errors to exist, while still at least printing them to `stderr` for insights (that were previously missing...) to anyone running the generator. Note that this once again allows the generator to fail further in the chain when expected elements are missing, in which case an update is required either way. If this happens often we can adjust `vk-parse` to be more lenient in still emitting errors but continuing to parse said element, if the new/unrecognized elements or attributes are considered harmless to the parsing process.
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.
Some upstream
vk.xmlchanges are causing failures on missing registry children later on in our generator code. These are complicated to debug, unless we print the errors thatvk-parsealready reports. In this debug case it was clarifying that some new and unknown elements upstream are the reason for high-level registry elements to not be parsable.