KhronosGroup / KhronosGroup/OpenCL-Docs

more error code consistency improvements

Open
#1,609 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

#1399 and related PRs improved error code consistency for many APIs, but many inconsistencies still remain. This issue is to track additional error code consistency improvements:

* [ ] Memory Objects:
* [ ] clRetainMemObject
* [ ] clReleaseMemObject
* [ ] clMemObjectDestructorCallback
* [ ] clEnqueueUnmapMemObject
* [ ] clEnqueueMigrateMemObjects
* [ ] clGetMemObjectInfo
* [ ] Images (old APIs)
* [ ] clCreateImage2D
* [ ] clCreateImage3D
* [ ] Samplers
* [ ] clCreateSamplerWithProperties
* [ ] clCreateSampler
* [ ] clRetainSampler
* [ ] clReleaseSampler
* [ ] clGetSamplerInfo
* [ ] Pipes:
* [ ] clGetPipeInfo
* [ ] clCreatePipe
* [ ] Programs
* [ ] clCreateProgramWithSource
* [ ] clCreateProgramWithIL
* [ ] clCreateProgramWithBinary
* [ ] clCreateProgramWithBuiltInKernels
* [ ] clRetainProgram
* [ ] clReleaseProgram
* [ ] clSetProgramReleaseCallback
* [ ] clSetProgramSpecializationConstant
* [ ] clBuildProgram
* [ ] clCompileProgram
* [ ] clLinkProgram
* [ ] clGetProgramInfo
* [ ] clGetProgramBuildInfo
* [ ] Kernels
* [ ] clCreateKernel
* [ ] clCreateKernelsInProgram
* [ ] clRetainKernel
* [ ] clReleaseKernel
* [ ] clSetKernelArgSVMPointer
* [ ] clSetKernelArgDevicePointerEXT
* [ ] clSetKernelExecInfo
* [ ] clCloneKernel
* [ ] clGetKernelInfo
* [ ] clGetKernelWorkGroupInfo
* [ ] clGetKernelSubGroupInfo
* [ ] clGetKernelArgInfo
* [ ] clEnqueueTask
* [ ] clEnqueueNativeKernel
* [ ] Compiler
* [ ] clUnloadPlatformCompiler
* [ ] Events
* [ ] clCreateUserEvent
* [ ] clSetUserEventStatus
* [ ] clWaitForEvents
* [ ] clGetEventInfo
* [ ] clSetEventCallback
* [ ] clRetainEvent
* [ ] clReleaseEvent
* [ ] clGetEventProfilingInfo
* [ ] Command Queues
* [ ] clFlush
* [ ] clFinish
* [ ] SVM
* [ ] clEnqueueSVMFree
* [ ] Markers and Barriers
* [ ] clEnqueueMarkerWithWaitList
* [ ] clEnqueueMarker
* [ ] clEnqueueWaitForEvents
* [ ] clEnqueueBarrierWithWaitList
* [ ] clEnqueueBarrier
* [ ] cl_khr_dx9_media_sharing
* [ ] clCreateFromDX9MediaSurfaceKHR
* [ ] clEnqueueAcquireDX9MediaSurfacesKHR
* [ ] clEnqueueReleaseDX9MediaSurfacesKHR
* [ ] cl_khr_d3d10_sharing
* [ ] clCreateFromD3D10BufferKHR
* [ ] clCreateFromD3D10Texture2DKHR
* [ ] clCreateFromD3D10Texture3DKHR
* [ ] clEnqueueAcquireD3D10ObjectsKHR
* [ ] clEnqueueReleaseD3D10ObjectsKHR
* [ ] cl_khr_d3d11_sharing
* [ ] clCreateFromD3D11BufferKHR
* [ ] clCreateFromD3D11Texture2DKHR
* [ ] clCreateFromD3D11Texture3DKHR
* [ ] clEnqueueAcquireD3D11ObjectsKHR
* [ ] clEnqueueReleaseD3D11ObjectsKHR
* [ ] cl_khr_egl_event
* [ ] clCreateEventFromEGLSyncKHR
* [ ] cl_khr_egl_image
* [ ] clCreateFromEGLImageKHR
* [ ] clEnqueueAcquireEGLObjectsKHR
* [ ] clEnqueueReleaseEGLObjectsKHR
* [ ] cl_khr_external_memory
* [ ] clEnqueueAcquireExternalMemObjectsKHR
* [ ] clEnqueueReleaseExternalMemObjectsKHR
* [ ] cl_khr_gl_event
* [ ] clCreateEventFromGLsyncKHR
* [ ] cl_khr_gl_sharing
* [ ] clGetGLObjectInfo
* [ ] clGetGLTextureInfo
* [ ] clCreateFromGLBuffer
* [ ] clCreateFromGLTexture
* [ ] clCreateFromGLRenderbuffer
* [ ] clEnqueueAcquireGLObjects
* [ ] clEnqueueReleaseGLObjects
* [ ] clGetGLContextInfoKHR
* [ ] cl_khr_semaphore, etc.
* [ ] clCreateSemaphoreWithPropertiesKHR
* [ ] clGetSemaphoreHandleForTypeKHR
* [ ] clReImportSemaphoreSyncFdKHR
* [ ] clEnqueueWaitSemaphoresKHR
* [ ] clEnqueueSignalSemaphoresKHR
* [ ] clRetainSemaphoreKHR
* [ ] clReleaseSemaphoreKHR
* [ ] clGetSemaphoreInfoKHR
* [ ] cl_khr_command_buffer
* [ ] clCreateCommandBufferKHR
* [ ] clRetainCommandBufferKHR
* [ ] clReleaseCommandBufferKHR
* [ ] clFinalizeCommandBufferKHR
* [ ] clEnqueueCommandBufferKHR
* [ ] clCommandBarrierWithWaitListKHR
* [ ] clCommandCopyBufferKHR
* [ ] clCommandCopyBufferRectKHR
* [ ] clCommandCopyBufferToImageKHR
* [ ] clCommandCopyImageKHR
* [ ] clCommandCopyImageToBufferKHR
* [ ] clCommandFillBufferKHR
* [ ] clCommandFillImageKHR
* [ ] clCommandNDRangeKernelKHR
* [ ] clCommandSVMMemcpyKHR
* [ ] clCommandSVMMemFillKHR
* [ ] clGetCommandBufferInfoKHR
* [ ] cl_khr_command_buffer_multi_device
* [ ] clRemapCommandBufferKHR
* [ ] cl_khr_command_buffer_mutable_dispatch
* [ ] clUpdateMutableCommandsKHR
* [ ] clGetMutableCommandInfoKHR

Contributor guide

Open the contributing guide

Research direction

Start by reviewing issue #1399 and its related pull requests to determine the intended error-code consistency rules. Use the checklist of OpenCL APIs as the scope; completion means the listed APIs follow those established conventions, but the issue does not identify source files or tests.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.