KhronosGroup / KhronosGroup/OpenCL-Docs

Centralise documentation of required minium values for device queries

Open
#425 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

Required minimum values for a number of queries are scattered throughout the specification which makes testing for these hard (see https://github.com/KhronosGroup/OpenCL-CTS/issues/928). Should we centralise the documentation of these like Vulkan does? This would make it easier to give an overview of the differences across profiles as well. The documentation for individual properties could link the centralised table for the exact values.

Contributor guide

Open the contributing guide

Research direction

Review the scattered required minimum values in the specification, the OpenCL-CTS issue 928, and Vulkan's centralized documentation approach. Identify how a central table could link from individual property documentation, cover profile differences, and make the values easier to test.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.