KhronosGroup / KhronosGroup/OpenCL-Docs
Spec consistency around param_value_size parameter for many OpenCL procedures
- Dominant language
- Python
- Stars
- 420
- Forks
- 131
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 11
Description
In few cases of OpenCL API spec mentioned that `param_value_size` is ignored if related `para_value` is NULL, eg. :
`param_value_size specifies the size in bytes of memory pointed to by param_value. This size must be ≥ size of return type as described in the table below. If param_value is NULL, it is ignored.`
This is the case for `clGetCommandBufferInfoKHR` and `clGetCommandQueueInfo`.
For below, similar cases this information is missing.
`clGetPlatformInfo, clGetDeviceInfo, clCreateSubDevices, clGetContextInfo, clGetSupportedImageFormats, clGetImageInfo, clGetPipeInfo, clGetMemObjectInfo, clGetGLTextureInfo, clGetSamplerInfo, clGetProgramInfo, clGetProgramBuildInfo, clCreateKernelsInProgram, clGetKernelInfo, clGetKernelWorkGroupInfo, clGetKernelSubGroupInfo, clGetKernelArgInfo, clGetEventInfo, clGetSemaphoreHandleForTypeKHR, clGetSemaphoreInfoKHR, clGetEventProfilingInfo, clGetMutableCommandInfoKHR, clGetGLContextInfoKHR`
Contributor guide
Research direction
Locate the OpenCL API specification entries for the listed procedures and compare their param_value_size wording with clGetCommandBufferInfoKHR and clGetCommandQueueInfo. Update the entries that omit the NULL behavior, then verify that the wording is consistent across all named procedures.
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
- 45/100