KhronosGroup / KhronosGroup/OpenCL-Docs

Update refpage category index

Open
#1,130 0 comments 1 reaction 2 assignees Claimed by @bashbaug View on GitHub
enhancement
Dominant language
Python
Stars
420
Forks
131
Avg merge
5d 13h
Merged PRs (30d)
11

Description

Per #1121, the category index for the reference pages (the file man/toctail) has not been updated for the current state of the refpages. Some extension and API pages are missing. As this file is not autogenerated, this is going to be an ongoing problem so I suggest two fixes:

- Update toctail for the current refpage set - this is for @bashbaug
- Create a CI script to check the contents of toctail against the generated refpages and report inconsistencies - I'll take a swing at this if you like. You might want to wait until the script is working before updating toctail.

While it is in principle possible to go further and autogenerate the category index, this would require tagging each reference page with the categories it belongs to, as this is probably tricky to infer from the existing metadata. That seems like a lot of additional work with updates to spec sources, scripts, refpage extraction script, and maybe XML needed.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.