Skip to content

Commit

Permalink
fixes a few incorrect asciidoctor attributes (#1091)
Browse files Browse the repository at this point in the history
  • Loading branch information
bashbaug committed Mar 26, 2024
1 parent 484432c commit be1aa79
Show file tree
Hide file tree
Showing 9 changed files with 34 additions and 33 deletions.
3 changes: 3 additions & 0 deletions OpenCL_API.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ include::config/version-local-links.asciidoc[]
// Formatting and links for API functions and enums.
include::api/dictionary.asciidoc[]

// Feature Dictionary - used by some extensions.
include::c/feature-dictionary.asciidoc[]

// External Footnotes
include::api/footnotes.asciidoc[]

Expand Down
16 changes: 8 additions & 8 deletions api/cl_khr_command_buffer.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,8 @@ features:

=== New Structures

* {cl_command_buffer_khr}
* {cl_mutable_command_khr}
* {cl_command_buffer_khr_TYPE}
* {cl_mutable_command_khr_TYPE}

=== New Types

Expand All @@ -227,19 +227,15 @@ features:
* {cl_device_info_TYPE}
** {CL_DEVICE_COMMAND_BUFFER_CAPABILITIES_KHR}
** {CL_DEVICE_COMMAND_BUFFER_REQUIRED_QUEUE_PROPERTIES_KHR}
* {cl_device_command_buffer_capabilities_khr - bitfield_TYPE}
* {cl_device_command_buffer_capabilities_khr_TYPE}
** {CL_COMMAND_BUFFER_CAPABILITY_KERNEL_PRINTF_KHR}
** {CL_COMMAND_BUFFER_CAPABILITY_DEVICE_SIDE_ENQUEUE_KHR}
** {CL_COMMAND_BUFFER_CAPABILITY_SIMULTANEOUS_USE_KHR}
** {CL_COMMAND_BUFFER_CAPABILITY_OUT_OF_ORDER_KHR}
* {cl_command_buffer_properties_khr_TYPE}
** {CL_COMMAND_BUFFER_FLAGS_KHR}
* {cl_command_buffer_flags_khr - bitfield_TYPE}
* {cl_command_buffer_flags_khr_TYPE}
** {CL_COMMAND_BUFFER_SIMULTANEOUS_USE_KHR}
* {Error codes_TYPE}
** {CL_INVALID_COMMAND_BUFFER_KHR}
** {CL_INVALID_SYNC_POINT_WAIT_LIST_KHR}
** {CL_INCOMPATIBLE_COMMAND_QUEUE_KHR}
* {cl_command_buffer_info_khr_TYPE}
** {CL_COMMAND_BUFFER_QUEUES_KHR}
** {CL_COMMAND_BUFFER_NUM_QUEUES_KHR}
Expand All @@ -253,6 +249,10 @@ features:
** {CL_COMMAND_BUFFER_STATE_PENDING_KHR}
* {cl_command_type_TYPE}
** {CL_COMMAND_COMMAND_BUFFER_KHR}
* New Error Codes
** {CL_INVALID_COMMAND_BUFFER_KHR}
** {CL_INVALID_SYNC_POINT_WAIT_LIST_KHR}
** {CL_INCOMPATIBLE_COMMAND_QUEUE_KHR}

=== Sample Code

Expand Down
2 changes: 1 addition & 1 deletion api/cl_khr_device_uuid.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ across processes or APIs.

Accepted value for the _param_name_ parameter to {clGetDeviceInfo}:

* {cl_device_info}
* {cl_device_info_TYPE}
** {CL_DEVICE_UUID_KHR}
** {CL_DRIVER_UUID_KHR}
** {CL_DEVICE_LUID_VALID_KHR}
Expand Down
2 changes: 1 addition & 1 deletion api/cl_khr_egl_event.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ context, and to reach into each such context.
. Should we restrict which CL APIs can be used with this cl_event?
+
--
*RESOLVED* Use is limited to {clEnqueueAcquire}*** calls only.
*RESOLVED* Use is limited to calls to acquire and release memory objects only.
--

. What is the desired behaviour for this extension when EGLSyncKHR is of a
Expand Down
4 changes: 2 additions & 2 deletions api/cl_khr_gl_sharing.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ object, using additional attributes described for {clCreateContext}.

An OpenCL image object may be created from an OpenGL texture or renderbuffer
object as described for {clCreateFromGLTexture} and
{clCreateFromGLRenderuffer}, respectively.
{clCreateFromGLRenderbuffer}, respectively.

An OpenCL buffer object may be created from an OpenGL buffer object using
{clCreateFromGLBuffer}.
Expand Down Expand Up @@ -59,7 +59,7 @@ and buffer object images with OpenCL is required by this extension.
* {cl_gl_context_info_TYPE}
* {cl_gl_object_type_TYPE}
* {cl_gl_texture_info_TYPE}
* {cl_gl_platform_info}
* {cl_gl_platform_info_TYPE}

=== New Tokens

Expand Down
2 changes: 1 addition & 1 deletion api/cl_khr_semaphore.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ In particular, this extension defines:
* New return values from {clGetEventInfo}
** {CL_COMMAND_SEMAPHORE_WAIT_KHR}
** {CL_COMMAND_SEMAPHORE_SIGNAL_KHR}
* New error codes
* New Error Codes
** {CL_INVALID_SEMAPHORE_KHR}


Expand Down
2 changes: 1 addition & 1 deletion api/cl_khr_subgroups.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ OpenCL C specification for more information.

=== New Types

* {cl_kernel_sub_group_info}
* {cl_kernel_sub_group_info_TYPE}

=== New Commands

Expand Down
8 changes: 4 additions & 4 deletions api/opencl_architecture.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2232,7 +2232,7 @@ working with version numbers easier.
{CL_VERSION_PATCH_BITS_anchor} are the number of bits in the
corresponding field.
* `CL_VERSION_MAJOR_MASK`, `CL_VERSION_MINOR_MASK`, and
{CL_VERSION_PATCH_MASK` are bitmasks used to extract the
`CL_VERSION_PATCH_MASK` are bitmasks used to extract the
corresponding packed fields from the version number.

[source,opencl]
Expand Down Expand Up @@ -2274,7 +2274,7 @@ corresponding entity (e.g. extension or built-in kernel) name:
include::{generated}/api/structs/cl_name_version.txt[]

* _version_ is a <<version-numbers, Version Number>>.
* _name_ is an array of {CL_NAME_VERSION_MAX_NAME_SIZE_anchor} `char`
containing a null-terminated string whose maximum length is therefore
{CL_NAME_VERSION_MAX_NAME_SIZE} - 1`.
* _name_ is an array of {CL_NAME_VERSION_MAX_NAME_SIZE_anchor} characters
containing a null-terminated string, whose maximum length is therefore
{CL_NAME_VERSION_MAX_NAME_SIZE} minus one.
--
28 changes: 13 additions & 15 deletions api/opencl_runtime_layer.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4727,19 +4727,19 @@ ifdef::cl_khr_egl_image[]

[open,refpage='clCreateFromEGLImageKHR',desc='Create cl_mem target from EGLImage source',type='protos']
--
To create an `EGLImage` target of type {cl_mem} from the `EGLImage` source
To create an `EGLImage` target of type {cl_mem_TYPE} from the `EGLImage` source
provided as _image_, call the function

include::{generated}/api/protos/clCreateFromEGLImageKHR.txt[]
include::{generated}/api/version-notes/clCreateFromEGLImageKHR.asciidoc[]

* _display_ should be of type `EGLDisplay`, cast into the type
{CLeglDisplayKHR}.
{CLeglDisplayKHR_TYPE}.
* _image_ should be of type `EGLImageKHR`, cast into the type
{CLeglImageKHR_TYPE}.
Assuming no errors are generated in this function, the resulting image
object will be an `EGLImage` target of the specified `EGLImage` _image_.
The resulting {cl_mem} is an image object which may be used normally by
The resulting {cl_mem_TYPE} is an image object which may be used normally by
all OpenCL operations.
This maps to an `image2d_t` type in OpenCL kernel code.
* _flags_ is a bit-field that is used to specify usage information about
Expand Down Expand Up @@ -4786,7 +4786,7 @@ returned in _errcode_ret_:
above.
* {CL_INVALID_EGL_OBJECT_KHR} if _image_ is not a valid `EGLImage` object.
* {CL_IMAGE_FORMAT_NOT_SUPPORTED} if the OpenCL implementation is not able
to create a {cl_mem} compatible with the provided {CLeglImageKHR_TYPE}
to create a {cl_mem_TYPE} compatible with the provided {CLeglImageKHR_TYPE}
for an implementation-dependent reason (this could be caused by, but not
limited to, reasons such as unsupported texture formats, etc).
* {CL_OUT_OF_HOST_MEMORY} if there is a failure to allocate resources
Expand Down Expand Up @@ -6264,7 +6264,7 @@ include::{generated}/api/version-notes/clGetGLTextureInfo.asciidoc[]
.OpenGL texture info that may be queried with {clGetGLTextureInfo}
[cols=",,",options="header",]
|====
| {cl_gl_texture_info} | Return Type | Info. Returned in _param_value_
| {cl_gl_texture_info_TYPE} | Return Type | Info. Returned in _param_value_
| {CL_GL_TEXTURE_TARGET_anchor}

include::{generated}/api/version-notes/CL_GL_TEXTURE_TARGET.asciidoc[]
Expand Down Expand Up @@ -7153,10 +7153,9 @@ memory objects through the other API with which such objects are shared.
Failure to provide such synchronization may result in race conditions and
other undefined behavior including non-portability between implementations.

Prior to acquiring objects shared with the other API via an appropriate
{clEnqueueAcquire}*** call, the application must ensure that any pending
operations in that API which accesses the objects specified in _mem_objects_
have completed.
Prior to acquiring objects shared with the other API, the application must
ensure that any pending operations in that API which accesses the objects
specified in _mem_objects_ have completed.

Depending on the application and the implementation, there are two
extensions which may be used to synchronize with other APIs:
Expand Down Expand Up @@ -7216,10 +7215,9 @@ are supported on a platform.

===== Synchronizing OpenCL Operations With Other APIs

After releasing a shared memory object via an appropriate
{clEnqueueRelease}*** call, the application is responsible for ensuring that
any pending OpenCL operations which access the objects specified in
_mem_objects_ have completed prior to executing subsequent commands in the
After releasing a shared memory object, the application is responsible for
ensuring that any pending OpenCL operations which access the objects specified
in _mem_objects_ have completed prior to executing subsequent commands in the
other API which reference these objects.

This may be accomplished portably by calling {clWaitForEvents} with the
Expand Down Expand Up @@ -12348,7 +12346,7 @@ When the event object is deleted, the reference will be removed from the EGL
sync object.

Events returned from {clCreateEventFromEGLSyncKHR} may only be consumed by
{clEnqueueAcquire}*** commands.
commands to acquire and release memory objects.
Passing such events to any other CL API that enqueues commands will generate
a {CL_INVALID_EVENT} error.

Expand Down Expand Up @@ -12452,7 +12450,7 @@ sync object.

Events returned from {clCreateEventFromGLsyncKHR} can be used in the
_event_wait_list_ argument to {clEnqueueAcquireGLObjects} and CL APIs that
take a {cl_event} as an argument but do not enqueue commands.
take a {cl_event_TYPE} as an argument but do not enqueue commands.
Passing such events to any other CL API that enqueues commands will generate
a {CL_INVALID_EVENT} error.
--
Expand Down

0 comments on commit be1aa79

Please sign in to comment.