KhronosGroup / KhronosGroup/OpenCL-Docs
Update placeholder extension revisions in XML
- Dominant language
- Python
- Stars
- 420
- Forks
- 131
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 11
Description
The PR https://github.com/KhronosGroup/OpenCL-Docs/pull/1161 makes the revision field of extensions a mandatory part of the XML. However, it has only been populated with the correct revision for KHR extensions where a correct semantic version is available. Vendor extensions and EXT extensions have less standardized versioning, and so a placeholder `0.0.0` version has been used instead to reduce the scope of the initial work.
This ticket captures the work needed by the owners of the vendor & EXT extensions to replace the placeholder revision values in their extension XML entries with a correct semantic version. At the time of creating https://github.com/KhronosGroup/OpenCL-Docs/pull/1161 those are:
* [ ] Apple - `cl_APPLE_SetMemObjectDestructor`, `cl_APPLE_ContextLoggingFunctions`.
* [ ] NVIDIA - `cl_nv_device_attribute_query`,
* [ ] AMD - `cl_amd_device_attribute_query`,
* [ ] ARM - `cl_arm_printf`, `cl_arm_import_memory`, `cl_arm_shared_virtual_memory`, `cl_arm_get_core_id`, `cl_arm_scheduling_controls`, `cl_arm_controlled_kernel_termination`, `cl_arm_protected_memory_allocation`, `cl_arm_job_slot_selection`
* [ ] Qualcomm - `cl_qcom_ext_host_ptr`, `cl_qcom_ext_host_ptr_iocoherent`, `cl_qcom_ion_host_ptr`, `cl_qcom_android_native_buffer_host_ptr`,
* [ ] IMG - `cl_img_yuv_image`, `cl_img_cached_allocations`, `cl_img_use_gralloc_ptr`, `cl_img_generate_mipmap`, `cl_img_mem_properties`, `cl_img_cancel_command`
* [ ] Intel - `cl_intel_exec_by_local_thread`, `cl_intel_device_partition_by_names`, `cl_intel_accelerator`, `cl_intel_motion_estimation`, `cl_intel_advanced_motion_estimation`, `cl_intel_simultaneous_sharing`, `cl_intel_egl_image_yuv`, `cl_intel_packed_yuv`, `cl_intel_required_subgroup_size`, `cl_intel_driver_diagnostics`, `cl_intel_planar_yuv`, `cl_intel_device_side_avc_motion_estimation`, `cl_intel_va_api_media_sharing`, `cl_intel_dx9_media_sharing`, `cl_intel_unified_shared_memory`, `cl_intel_create_buffer_with_properties`, `cl_intel_mem_channel_property`, `cl_intel_mem_alloc_buffer_location`, `cl_intel_mem_force_host_memory`, `cl_intel_command_queue_families`, `cl_intel_device_attribute_query`, `cl_intel_sharing_format_query`, `cl_intel_sharing_format_query_gl`, `cl_intel_sharing_format_query_dx9`, `cl_intel_sharing_format_query_d3d10`, `cl_intel_sharing_format_query_d3d11`, `cl_intel_sharing_format_query_va_api`, `cl_intel_program_scope_host_pipe`, `cl_intel_queue_no_sync_operations`, `cl_intel_create_mem_object_properties`,
* [ ] PoCL - `cl_pocl_content_size`
EXTs:
* [ ] `cl_ext_device_fission`
* [ ] `cl_ext_migrate_memobject`
* [ ] `cl_ext_cxx_for_opencl`
* [ ] `cl_ext_float_atomics`
* [ ] `cl_ext_image_requirements_info`
* [ ] `cl_ext_image_from_buffer`
* [ ] `cl_ext_image_raw10_raw12`
Contributor guide
Research direction
Start with PR #1161 and the listed vendor and EXT XML entries; identify each placeholder 0.0.0 and consult the relevant extension owners or specifications for authoritative semantic revisions. Replace only confirmed values and verify that every listed entry no longer uses a placeholder revision.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- xml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100