KhronosGroup / KhronosGroup/OpenCL-Docs

CL_VERSION_2_1 and CL_VERSION_2_2 missing in documentation

Open
#249 7 comments 0 reactions 0 assignees View on GitHub
OpenCL API Spec OpenCL C Spec
Dominant language
Python
Stars
420
Forks
131
Avg merge
5d 13h
Merged PRs (30d)
11

Description

It is documented, that one can test the api version up to OpenCL 2.0 by testing macros like `CL_VERSION_2_0`. However the macros `CL_VERSION_2_1` and `CL_VERSION_2_2` are missing in the documentation, although they are defined in the header. Are these makros guarantied to be defined (in OpenCL 2.2) and just missing from the documentation or could there be conforming implementations, that don't define those?

Note: even the makros up to `CL_VERSION_2_0` are only documented in the [Appendix E: Changes to OpenCL](https://github.com/KhronosGroup/OpenCL-Docs/blob/master/api/appendix_e.asciidoc) and not in the main text.

Note 2: The string `CL_VERSION_2_2` does appear in [xml/cl.xml on line 4303](https://github.com/KhronosGroup/OpenCL-Docs/blob/master/xml/cl.xml#L4303) but I don't really get if that does mean, that a macro of that name is defined...

Contributor guide

Open the contributing guide

Research direction

Start with Appendix E: Changes to OpenCL and the CL_VERSION_2_2 entry in xml/cl.xml, then compare how CL_VERSION_2_0 is documented. Confirm the intended guarantee for CL_VERSION_2_1 and CL_VERSION_2_2 and update the relevant documentation, including the main text if appropriate. Done means the macro definitions and conformance expectations are stated clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.