search

KhronosGroup / OpenCL-Docs

OpenCL API, OpenCL C, Extensions, SPIR-V Environment Specs, Ref page, and C++ for OpenCL doc sources.
Other
359 stars 113 forks source link

Reference pages link to non-existent extension anchors #681

Open alycm opened 3 years ago

alycm commented 3 years ago

Various links in man/static/clFOO.txt link to OpenCL_Ext.html#clFoo when there is no clFoo anchor in that document. This doesn't cause much of an issue, as the link exists, you just land at the top of the document.

The fix is either to link to the anchor of the extension that describes clFoo, or to add an anchor for clFoo.

This is the list of offending links I found (the links appear like this in the source verbatim, so you can find them by searching):

bashbaug commented 3 years ago

I think we should just add the anchors.

We just started generating the function prototypes for extension functions recently, so if we switch to those we'll always be in sync with the XML file and we'll get the anchors automatically. I've been using the automatically generated prototypes for an upcoming extension and it has worked out very well.

oddhack commented 3 years ago

I believe all of those come from static refpages (under man/static/) that exist because there is not an extractable refpage for that API in the extension spec. The extensions are written as diffs rather than containing a compact description of each API that can be tagged for extraction. So if there's a natural place to attach the anchor that would be great; if not, the corresponding file in man/static/ can be edited to remove the link from the "Document Notes" section.