KhronosGroup / KhronosGroup/Vulkan-Docs

Feedback on the XML registry schema

Open
#2,596 4 comments 3 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
3.3k
Forks
549
Avg merge
5d 5h
Merged PRs (30d)
2

Description

Were you just expecting people to feed the contents of the type tags to a C compiler frontend or what? What's the point of putting all this information into an XML document if half its contents is just gonna be barely annotated C code anyway. Did anyone think this through or did you not realize it would only be useful for generating C headers?

Just redo the whole thing at this point, add a version number to the registry root tag and create a new schema from the ground up. People are already using third party rewrites of the damn thing anyway, it's not like anyone is using the existing document directly as it stands. No one's gonna care about back compat if no one was realistically using the original version.

And no, this isn't flame for its own sake, I genuinely want things to improve, I'm just extremely frustrated at how sloppily this was initially handled and how stubborn the existing direction is about keeping the current format. Please actually write something worthy of an *international, industry-wide standard*.

Contributor guide

Open the contributing guide

Research direction

The issue concerns the XML registry schema, but names no files, tests, or entry points. Start by locating the current registry document and its schema-validation workflow, then confirm the proposed scope with maintainers before making changes. Done would require an agreed replacement schema with a versioned registry root and corresponding validation coverage.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.