KhronosGroup / KhronosGroup/OpenCL-Docs

Use XML revision tag for extensions to generate specification revisions

Open
#1,169 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
420
Forks
131
Avg merge
5d 13h
Merged PRs (30d)
11

Description

PR https://github.com/KhronosGroup/OpenCL-Docs/pull/1161 enforces that every extension defined by the XML must have a revision associated with it.

This revision will be used to generate an extension version in the headers, but it could also be used to generate the revision set in the human readable OpenCL specification. Currently, if an implementer wants to update the version of an extension they need to remember to update **both** the specification document and the XML entry. However, it would be less error prone to have the XML as the single source of truth that is used to generate the rendered specification document.

This may be blocked on https://github.com/KhronosGroup/OpenCL-Docs/issues/1168 so that all the revision XML entries are accurate, as we don't want to use the placeholder values in the rendered spec. Although we could check and only use the XML revision in the rendered specification if it isn't a placeholder value.

Contributor guide

Open the contributing guide

Research direction

Start by tracing how XML extension entries are consumed when the human-readable specification is rendered. Check issue 1168 before using revision values, and compare the generated revision set with the XML source. Done means the rendered specification derives extension revisions from XML without using placeholder values.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.