KhronosGroup / KhronosGroup/OpenCL-Docs

Inconsistent enum labeling for `cl_khr_dx9_media_sharing` enums

Open Beginner friendly
#1,585 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

In [cl_khr_dx9_media_sharing](https://github.com/KhronosGroup/OpenCL-Docs/blob/main/api/cl_khr_dx9_media_sharing.asciidoc) the following enum constants are defined as being part of the `cl_context_info` enumeration.

But looking at https://github.com/KhronosGroup/OpenCL-Docs/blob/main/man/static/enums.txt which documents all valid enum values for each enumeration these values seem to be listed under `cl_context_properties`.

However, in `cl.xml` these enums are included under a `cl_context_info` comment.
https://github.com/KhronosGroup/OpenCL-Docs/blob/main/xml/cl.xml#L5914-L5917

It does seem likely from [other specification wording](https://registry.khronos.org/OpenCL/specs/unified/refpages/man/html/clCreateContextFromType.html#:~:text=CL_INVALID_DX9_MEDIA_,created%20may%20interoperate) that the correct enum is indeed `cl_context_properties` but it's a little hard to know.

If the `cl_khr_dx9_media_sharing` file is wrong it and `cl.xml` should be updated to reflect the correct enumeration for these values.

Contributor guide

Open the contributing guide

Research direction

Compare the enum definitions in api/cl_khr_dx9_media_sharing.asciidoc, the entries in man/static/enums.txt, and the cl_context_info comment in xml/cl.xml. Check the linked clCreateContextFromType wording to determine the correct enumeration, then update the inconsistent documentation sources so all three agree.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.