KhronosGroup / KhronosGroup/OpenCL-Docs

Generate OpenCL C feature dictionary

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

Description

The macros for OpenCL C features are currently defined manually in `c/feature-dictionary.asciidoc`. Here is an example:

```
// opencl_c_kernel_clock_scope_sub_group
ifdef::backend-html5[]
:opencl_c_kernel_clock_scope_sub_group: pass:q[`\__opencl_c_kernel_clock_scope_sub_group`]
endif::[]
ifndef::backend-html5[]
:opencl_c_kernel_clock_scope_sub_group: pass:q[`\__opencl_c_​kernel_​clock_​scope_​sub_​group`]
endif::[]
```

Authoring these manually is tedious and error prone. They should be generated from the XML.

Contributor guide

Open the contributing guide

Research direction

Start by inspecting c/feature-dictionary.asciidoc and the XML definitions for OpenCL C features, then trace the documentation-generation workflow that consumes them. The work is done when the feature macros are generated from the XML rather than maintained manually and the resulting dictionary preserves the documented HTML and non-HTML forms.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
build-system, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.