KhronosGroup / KhronosGroup/OpenCL-Docs

Split up the OpenCL C specification Asciidoctor Source

Open
#450 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
421
Forks
132
Avg merge
5d 13h
Merged PRs (30d)
11

Description

The OpenCL C specification is almost entirely in a single file. All the other specifications are split up per section. For OpenCL C section 6 does account for 85% of the specification though, maybe that could be split by sub-section.

$ wc -l OpenCL_*txt
    67 OpenCL_API.txt
 12342 OpenCL_C.txt
   157 OpenCL_Cxx.txt
    45 OpenCL_Env.txt
    99 OpenCL_Ext.txt
   124 OpenCL_ICD_Installation.txt
    39 OpenCL_LangExt.txt

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading OpenCL_C.txt and compare its structure with the other OpenCL_*txt sources, using the provided line counts to identify the scope. Split the OpenCL C source by section or subsection while preserving the generated specification and confirming the documentation build still succeeds.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.