Skip to content

Commit b88578e

Browse files
authored
fix linking for several extension APIs and enums (#1360)
1 parent 1016879 commit b88578e

5 files changed

Lines changed: 18 additions & 18 deletions

api/cl_ext_buffer_device_address.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ include::{generated}/meta/{refprefix}cl_ext_buffer_device_address.txt[]
1818

1919
=== Description
2020

21-
This extension provides access to raw device pointers for cl_mem buffers
21+
This extension provides access to raw device pointers for {cl_mem_TYPE} buffers
2222
without requiring a shared virtual address space between the host and
2323
the device.
2424

@@ -67,14 +67,14 @@ can allocate.
6767
** Initial version for detailed review.
6868
* Revision 1.0.1, 2025-01-28
6969
** Made it explicit that passing illegal pointers is legal as long as they are
70-
not referenced. Removed CL_INVALID_ARG_VALUE as a possible error in
71-
clSetKernelArgDevicePointerEXT() as there are no illegal pointer
72-
cases when calling this function. Return CL_INVALID_OPERATION for
73-
clGetMemObjectInfo() if the pointer is not a buffer device pointer.
74-
clSetKernelExecInfo() and clSetKernelArgDevicePointerEXT() now only
70+
not referenced. Removed {CL_INVALID_ARG_VALUE} as a possible error in
71+
{clSetKernelArgDevicePointerEXT} as there are no illegal pointer
72+
cases when calling this function. Return {CL_INVALID_OPERATION} for
73+
{clGetMemObjectInfo} if the pointer is not a buffer device pointer.
74+
{clSetKernelExecInfo} and {clSetKernelArgDevicePointerEXT} now only
7575
error out if no devices in the context associated with kernel support
7676
device pointers.
7777
* Revision 1.0.2, 2025-02-04
78-
** Converted the clSetKernelArgDevicePointerEXT() address parameter to
78+
** Converted the {clSetKernelArgDevicePointerEXT} address parameter to
7979
a value instead of a pointer to the value.
8080

api/cl_ext_image_from_buffer.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ object.
4545

4646
//. TODO Test copy to/from another image?
4747

48-
. Test clGetImageInfo
48+
. Test {clGetImageInfo}
4949
- For all image types (one format per element size)
5050
- For a few different row/pitch sizes (image dimensions being equal or not)
5151
- Create an image from a buffer
5252
- Check that the returned values for {CL_IMAGE_ROW_PITCH} and {CL_IMAGE_SLICE_PITCH} are correct.
5353

54-
. Test clGetMemObjectInfo
54+
. Test {clGetMemObjectInfo}
5555
- For all image types (1 format only)
5656
- Create an image from a buffer
5757
- Check that {CL_MEM_ASSOCIATED_MEMOBJECT} correctly returns the buffer that was used.

api/cl_khr_gl_sharing.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ an arbitrary OpenGL or OpenGL ES context with respect to one of the
9696
window-system binding layers EGL, GLX, or WGL, or a share group handle to
9797
identify a CGL share group.
9898
If a context is specified, it need not be current to the thread calling
99-
clCreateContext*.
99+
{clCreateContext}.
100100

101101
A previously suggested approach would use a single boolean attribute
102102
CL_USE_GL_CONTEXT_KHR to allow creating a context associated with the
@@ -168,8 +168,8 @@ Sharing between OpenCL and OpenGL requires integration at the driver
168168
internals level.
169169
--
170170

171-
. What command-queues can *clEnqueueAcquire/ReleaseGLObjects* be placed
172-
on?
171+
. What command-queues can {clEnqueueAcquireGLObjects} and
172+
{clEnqueueReleaseGLObjects} be placed on?
173173
+
174174
--
175175
*RESOLVED*: All command-queues.
@@ -221,7 +221,7 @@ All extension language has now been integrated into the unified
221221
Specification and this distinction is not useful.
222222
--
223223

224-
. Where are the `clCreateFromGLTexture2D` and `clCreateFromGLTexture3D`
224+
. Where are the {clCreateFromGLTexture2D} and {clCreateFromGLTexture3D}
225225
fuctions described?
226226
+
227227
--

api/cl_khr_icd.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ New in version 2.0.0, object that are ICD 2 compatible should also contain
7373
a `dispatch_data` field of type `void *` that the loader is free to modify
7474
for a platform through the {clIcdSetPlatformDispatchDataKHR} new API entry
7575
point. In order to distinguish ICD 1 and ICD 2 objects, the pointers to
76-
`clGetPlatformIDs` and `clUnloadCompiler` in the dispatch structure must be
76+
{clGetPlatformIDs} and {clUnloadCompiler} in the dispatch structure must be
7777
set to `CL_ICD2_TAG_KHR`. The vendor driver is responsible for propagating
7878
the `dispatch_data` value when returning objects to users.
7979

@@ -242,7 +242,7 @@ continue on to the next.
242242
New in version 2.0.0, the ICD Loader will also query the following functions
243243
from the library: {clIcdGetFunctionAddressForPlatformKHR} and
244244
{clIcdSetPlatformDispatchDataKHR}. If these two functions are present and the
245-
pointers to `clGetPlatformIDs` and `clUnloadCompiler` in the dispatch
245+
pointers to {clGetPlatformIDs} and {clUnloadCompiler} in the dispatch
246246
structure of a platform is set to `CL_ICD2_TAG_KHR` the platform will be
247247
deemed ICD 2 compatible and dispatch will be managed by the ICD Loader. If the
248248
`CL_ICD2_TAG_KHR` tag is present but one of the two functions above is
@@ -274,8 +274,8 @@ Returned by {clGetPlatformIDs} when no platforms are found:
274274

275275
* {CL_PLATFORM_NOT_FOUND_KHR}
276276

277-
New in version 2.0.0, used as a value in the pointers to `clGetPlatformIDs`
278-
and `clUnloadCompiler` in the dispatch structure:
277+
New in version 2.0.0, used as a value in the pointers to {clGetPlatformIDs}
278+
and {clUnloadCompiler} in the dispatch structure:
279279

280280
* `CL_ICD2_TAG_KHR`
281281

api/cl_khr_spirv_linkonce_odr.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ include::{generated}/meta/{refprefix}cl_khr_spirv_linkonce_odr.txt[]
1212

1313
=== Description
1414

15-
`cl_khr_spirv_linkonce_odr` allows use of the SPIR-V extension
15+
The {cl_khr_spirv_linkonce_odr_EXT} extension allows use of the SPIR-V extension
1616
`SPV_KHR_linkonce_odr`.
1717

1818
See the

0 commit comments

Comments
 (0)