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

[Registry] Incorrect(?) description of unused attributes #2395

Closed
Waffl3x opened this issue Jul 22, 2024 · 3 comments · Fixed by #2417
Closed

[Registry] Incorrect(?) description of unused attributes #2395

Waffl3x opened this issue Jul 22, 2024 · 3 comments · Fixed by #2417

Comments

@Waffl3x
Copy link
Contributor

Waffl3x commented Jul 22, 2024

https://registry.khronos.org/vulkan/specs/1.3/registry.html#_attributes_of_feature_tags
sortorder - optional. A decimal number which specifies an order relative to other feature tags when calling output generators. Defaults to 0. Rarely used, for when ordering by name is insufficient.
It seems to me like "Rarely used" is incorrect as the registry currently does not make use of this attribute. I think "currently unused" would be more accurate.
protect - optional. An additional preprocessor token used to protect a feature definition. Usually another feature or extension name. Rarely used, for odd circumstances where the definition of a feature or extension requires another to be defined first.
Same thing here.

@oddhack
Copy link
Contributor

oddhack commented Jul 22, 2024

I'd rather not switch the language back and forth as we may need to use it at some point, and may stop using it afterwards if so, and this applies across multiple Khronos repositories that use basically the same schema. So I suggest closing this as WONTFIX.

@Waffl3x
Copy link
Contributor Author

Waffl3x commented Jul 22, 2024

I would settle for a note below, just anything to save myself or others in the future the time investigating whether it actually needs to be handled or not. Besides, trying to handle for it when it's not even used, who's to say it would be done properly, the only logical thing is to immediately error out if you do encounter it so you know you have to rework code to handle it going forward.

oddhack added a commit that referenced this issue Aug 21, 2024
…ined attributes and tags

and refer to it for sortorder and protect attributes

Closes #2395
@oddhack
Copy link
Contributor

oddhack commented Aug 23, 2024

The 1.3.294 spec update includes new language from #2417 closing this issue. Hopefully that will suffice.

This issue was closed.
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 a pull request may close this issue.

2 participants