KhronosGroup / KhronosGroup/OpenCL-Docs
Consider Parameter Validation Described in XML Schema
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 421
- Forks
- 132
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 11
Description
In PR https://github.com/KhronosGroup/OpenCL-Layers/pull/11 @MathiasMagnus proposes an extension to the schema used for cl.xml to allow for automatic generation of parameter validation in a layer. There is a description of the schema additions in the PR description.
Jon replied with significant feedback on how other APIs are using XML as the source of truth for validation in a comment: https://github.com/KhronosGroup/OpenCL-Layers/pull/11#issuecomment-1171279617
Opening an issue here because if we did take such an approach the central XML file here would need updated. It would also be prudent to avoid specifying all the validation twice, i.e. automatically generating the extension wording from the XML. That would be a significant change to the source of the specification.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the proposed schema additions in PR #11 and Jon's linked comment about XML as the validation source of truth. Then inspect cl.xml and how the specification text and layer validation are generated. Done means reaching a decided approach for the schema, validation generation, and avoiding duplicated extension wording.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100