Skip to content

Commit

Permalink
add a TYPE suffix to all asciidoctor type attributes (#444)
Browse files Browse the repository at this point in the history 
Because asciidoctor attributes are not currently case-sensitive,
the TYPE suffix is needed to disambiguate between an API type and
an enum with the same name.
  • Loading branch information
@bashbaug
bashbaug authored Sep 16, 2020
1 parent 68d6c31 commit bb7df89
Show file tree
Hide file tree
Showing 9 changed files with 349 additions and 345 deletions.
8 changes: 4 additions & 4 deletions api/appendix_a.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,15 @@ being used by another command-queue are undefined.
== Multiple Host Threads

All OpenCL API calls are thread-safe footnote:[{fn-thread-safe}] except those
that modify the state of {cl_kernel} objects: {clSetKernelArg},
that modify the state of {cl_kernel_TYPE} objects: {clSetKernelArg},
{clSetKernelArgSVMPointer}, {clSetKernelExecInfo} and {clCloneKernel}.
{clSetKernelArg}, {clSetKernelArgSVMPointer}, {clSetKernelExecInfo} and
{clCloneKernel} are safe to call from any host thread, and safe to call
re-entrantly so long as concurrent calls to any combination of these API
calls operate on different {cl_kernel} objects.
The state of the {cl_kernel} object is undefined if {clSetKernelArg},
calls operate on different {cl_kernel_TYPE} objects.
The state of the {cl_kernel_TYPE} object is undefined if {clSetKernelArg},
{clSetKernelArgSVMPointer}, {clSetKernelExecInfo} or {clCloneKernel} are
called from multiple host threads on the same {cl_kernel} object at the same
called from multiple host threads on the same {cl_kernel_TYPE} object at the same
time footnote:[{fn-race-condition}].
Please note that there are additional limitations as to which OpenCL APIs
may be called from <<event-objects,OpenCL callback functions>>.
Expand Down
74 changes: 37 additions & 37 deletions api/appendix_c.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -291,154 +291,154 @@ include::{generated}/api/version-notes/CL_CHAR_BIT.asciidoc[]
| {CL_SCHAR_MAX_anchor}

include::{generated}/api/version-notes/CL_SCHAR_MAX.asciidoc[]
| Maximum value of a type {cl_char}
| Maximum value of a type {cl_char_TYPE}
| {CL_SCHAR_MIN_anchor}

include::{generated}/api/version-notes/CL_SCHAR_MIN.asciidoc[]
| Minimum value of a type {cl_char}
| Minimum value of a type {cl_char_TYPE}
| {CL_CHAR_MAX_anchor}

include::{generated}/api/version-notes/CL_CHAR_MAX.asciidoc[]
| Maximum value of a type {cl_char}
| Maximum value of a type {cl_char_TYPE}
| {CL_CHAR_MIN_anchor}

include::{generated}/api/version-notes/CL_CHAR_MIN.asciidoc[]
| Minimum value of a type {cl_char}
| Minimum value of a type {cl_char_TYPE}
| {CL_UCHAR_MAX_anchor}

include::{generated}/api/version-notes/CL_UCHAR_MAX.asciidoc[]
| Maximum value of a type {cl_uchar}
| Maximum value of a type {cl_uchar_TYPE}
| {CL_SHRT_MAX_anchor}

include::{generated}/api/version-notes/CL_SHRT_MAX.asciidoc[]
| Maximum value of a type {cl_short}
| Maximum value of a type {cl_short_TYPE}
| {CL_SHRT_MIN_anchor}

include::{generated}/api/version-notes/CL_SHRT_MIN.asciidoc[]
| Minimum value of a type {cl_short}
| Minimum value of a type {cl_short_TYPE}
| {CL_USHRT_MAX_anchor}

include::{generated}/api/version-notes/CL_USHRT_MAX.asciidoc[]
| Maximum value of a type {cl_ushort}
| Maximum value of a type {cl_ushort_TYPE}
| {CL_INT_MAX_anchor}

include::{generated}/api/version-notes/CL_INT_MAX.asciidoc[]
| Maximum value of a type {cl_int}
| Maximum value of a type {cl_int_TYPE}
| {CL_INT_MIN_anchor}

include::{generated}/api/version-notes/CL_INT_MIN.asciidoc[]
| Minimum value of a type {cl_int}
| Minimum value of a type {cl_int_TYPE}
| {CL_UINT_MAX_anchor}

include::{generated}/api/version-notes/CL_UINT_MAX.asciidoc[]
| Maximum value of a type {cl_uint}
| Maximum value of a type {cl_uint_TYPE}
| {CL_LONG_MAX_anchor}

include::{generated}/api/version-notes/CL_LONG_MAX.asciidoc[]
| Maximum value of a type {cl_long}
| Maximum value of a type {cl_long_TYPE}
| {CL_LONG_MIN_anchor}

include::{generated}/api/version-notes/CL_LONG_MIN.asciidoc[]
| Minimum value of a type {cl_long}
| Minimum value of a type {cl_long_TYPE}
| {CL_ULONG_MAX_anchor}

include::{generated}/api/version-notes/CL_ULONG_MAX.asciidoc[]
| Maximum value of a type {cl_ulong}
| Maximum value of a type {cl_ulong_TYPE}
| {CL_FLT_DIG_anchor}

include::{generated}/api/version-notes/CL_FLT_DIG.asciidoc[]
| Number of decimal digits of precision for the type {cl_float}
| Number of decimal digits of precision for the type {cl_float_TYPE}
| {CL_FLT_MANT_DIG_anchor}

include::{generated}/api/version-notes/CL_FLT_MANT_DIG.asciidoc[]
| Number of digits in the mantissa of type {cl_float}
| Number of digits in the mantissa of type {cl_float_TYPE}
| {CL_FLT_MAX_10_EXP_anchor}

include::{generated}/api/version-notes/CL_FLT_MAX_10_EXP.asciidoc[]
| Maximum positive integer such that 10 raised to this power minus one can
be represented as a normalized floating-point number of type {cl_float}
be represented as a normalized floating-point number of type {cl_float_TYPE}
| {CL_FLT_MAX_EXP_anchor}

include::{generated}/api/version-notes/CL_FLT_MAX_EXP.asciidoc[]
| Maximum exponent value of type {cl_float}
| Maximum exponent value of type {cl_float_TYPE}
| {CL_FLT_MIN_10_EXP_anchor}

include::{generated}/api/version-notes/CL_FLT_MIN_10_EXP.asciidoc[]
| Minimum negative integer such that 10 raised to this power minus one can
be represented as a normalized floating-point number of type {cl_float}
be represented as a normalized floating-point number of type {cl_float_TYPE}
| {CL_FLT_MIN_EXP_anchor}

include::{generated}/api/version-notes/CL_FLT_MIN_EXP.asciidoc[]
| Minimum exponent value of type {cl_float}
| Minimum exponent value of type {cl_float_TYPE}
| {CL_FLT_RADIX_anchor}

include::{generated}/api/version-notes/CL_FLT_RADIX.asciidoc[]
| Base value of type {cl_float}
| Base value of type {cl_float_TYPE}
| {CL_FLT_MAX_anchor}

include::{generated}/api/version-notes/CL_FLT_MAX.asciidoc[]
| Maximum value of type {cl_float}
| Maximum value of type {cl_float_TYPE}
| {CL_FLT_MIN_anchor}

include::{generated}/api/version-notes/CL_FLT_MIN.asciidoc[]
| Minimum value of type {cl_float}
| Minimum value of type {cl_float_TYPE}
| {CL_FLT_EPSILON_anchor}

include::{generated}/api/version-notes/CL_FLT_EPSILON.asciidoc[]
| Minimum positive floating-point number of type {cl_float} such that `1.0
| Minimum positive floating-point number of type {cl_float_TYPE} such that `1.0
{plus} {CL_FLT_EPSILON} != 1` is true.
| {CL_DBL_DIG_anchor}

include::{generated}/api/version-notes/CL_DBL_DIG.asciidoc[]
Also see extension *cl_khr_fp64*.
| Number of decimal digits of precision for the type {cl_double}
| Number of decimal digits of precision for the type {cl_double_TYPE}
| {CL_DBL_MANT_DIG_anchor}

include::{generated}/api/version-notes/CL_DBL_MANT_DIG.asciidoc[]
Also see extension *cl_khr_fp64*.
| Number of digits in the mantissa of type {cl_double}
| Number of digits in the mantissa of type {cl_double_TYPE}
| {CL_DBL_MAX_10_EXP_anchor}

include::{generated}/api/version-notes/CL_DBL_MAX_10_EXP.asciidoc[]
Also see extension *cl_khr_fp64*.
| Maximum positive integer such that 10 raised to this power minus one can
be represented as a normalized floating-point number of type {cl_double}
be represented as a normalized floating-point number of type {cl_double_TYPE}
| {CL_DBL_MAX_EXP_anchor}

include::{generated}/api/version-notes/CL_DBL_MAX_EXP.asciidoc[]
Also see extension *cl_khr_fp64*.
| Maximum exponent value of type {cl_double}
| Maximum exponent value of type {cl_double_TYPE}
| {CL_DBL_MIN_10_EXP_anchor}

include::{generated}/api/version-notes/CL_DBL_MIN_10_EXP.asciidoc[]
Also see extension *cl_khr_fp64*.
| Minimum negative integer such that 10 raised to this power minus one can
be represented as a normalized floating-point number of type {cl_double}
be represented as a normalized floating-point number of type {cl_double_TYPE}
| {CL_DBL_MIN_EXP_anchor}

include::{generated}/api/version-notes/CL_DBL_MIN_EXP.asciidoc[]
Also see extension *cl_khr_fp64*.
| Minimum exponent value of type {cl_double}
| Minimum exponent value of type {cl_double_TYPE}
| {CL_DBL_RADIX_anchor}

include::{generated}/api/version-notes/CL_DBL_RADIX.asciidoc[]
Also see extension *cl_khr_fp64*.
| Base value of type {cl_double}
| Base value of type {cl_double_TYPE}
| {CL_DBL_MAX_anchor}

include::{generated}/api/version-notes/CL_DBL_MAX.asciidoc[]
Also see extension *cl_khr_fp64*.
| Maximum value of type {cl_double}
| Maximum value of type {cl_double_TYPE}
| {CL_DBL_MIN_anchor}

include::{generated}/api/version-notes/CL_DBL_MIN.asciidoc[]
Also see extension *cl_khr_fp64*.
| Minimum value of type {cl_double}
| Minimum value of type {cl_double_TYPE}
| {CL_DBL_EPSILON_anchor}

include::{generated}/api/version-notes/CL_DBL_EPSILON.asciidoc[]
Also see extension *cl_khr_fp64*.
| Minimum positive floating-point number of type {cl_double} such that
| Minimum positive floating-point number of type {cl_double_TYPE} such that
`1.0 {plus} {CL_DBL_EPSILON} != 1` is true.
| {CL_NAN_anchor}

Expand All @@ -447,15 +447,15 @@ include::{generated}/api/version-notes/CL_NAN.asciidoc[]
| {CL_HUGE_VALF_anchor}

include::{generated}/api/version-notes/CL_HUGE_VALF.asciidoc[]
| Largest representative value of type {cl_float}
| Largest representative value of type {cl_float_TYPE}
| {CL_HUGE_VAL_anchor}

include::{generated}/api/version-notes/CL_HUGE_VAL.asciidoc[]
| Largest representative value of type {cl_double}
| Largest representative value of type {cl_double_TYPE}
| {CL_MAXFLOAT_anchor}

include::{generated}/api/version-notes/CL_MAXFLOAT.asciidoc[]
| Maximum value of type {cl_float}
| Maximum value of type {cl_float_TYPE}
| {CL_INFINITY_anchor}

include::{generated}/api/version-notes/CL_INFINITY.asciidoc[]
Expand Down
14 changes: 7 additions & 7 deletions api/appendix_e.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,18 +116,18 @@ runtime (_sections 4 and 5_):

* Custom devices and built-in kernels are supported.
{clCreateProgramWithBuiltInKernels} has been added to allow creation of
_cl_program_ using built-in kernels.
a {cl_program_TYPE} using built-in kernels.
* Device partitioning that allows a device to be partitioned based on a
number of partitioning schemes supported by the device. This is done by
using {clCreateSubDevices} to create a new _cl_device_id_ based on a
using {clCreateSubDevices} to create a new {cl_device_id_TYPE} based on a
partitioning.
* {clCompileProgram} and {clLinkProgram} to allow handling these aspects
{clBuildProgram} separately.
* Extend _cl_mem_flags_ to describe how the host accesses the data in a
{cl_mem} object.
* Extend {cl_mem_flags_TYPE} to describe how the host accesses the data in a
{cl_mem_TYPE} object.
* {clEnqueueFillBuffer} and {clEnqueueFillImage} to support filling a
buffer with a pattern or an image with a color.
* Add {CL_MAP_WRITE_INVALIDATE_REGION} to _cl_map_flags_.
* Add {CL_MAP_WRITE_INVALIDATE_REGION} to {cl_map_flags_TYPE}.
Appropriate clarification to the behavior of {CL_MAP_WRITE} has been added
to the spec.
* New image types: 1D image, 1D image from a buffer object, 1D image array
Expand All @@ -145,7 +145,7 @@ runtime (_sections 4 and 5_):
a kernel.
* {clEnqueueMarkerWithWaitList} and {clEnqueueBarrierWithWaitList} APIs.
* {clUnloadPlatformCompiler} to request that a single platform's compiler is
unloaded. This is compatible with the `cl_khr_icd` extension if that is
unloaded. This is compatible with the *cl_khr_icd* extension if that is
supported, unlike {clUnloadCompiler}.

The following features are added to the OpenCL C programming language
Expand Down Expand Up @@ -182,7 +182,7 @@ The following APIs in OpenCL 1.1 are deprecated (see glossary) in OpenCL
// Bugzilla 5391 - cl_khr_icd specification
* {clUnloadCompiler} and {clGetExtensionFunctionAddress} APIs are deprecated.
The {clUnloadPlatformCompiler} and {clGetExtensionFunctionAddressForPlatform}
APIs provide equivalent functionality are compatible with the `cl_khr_icd`
APIs provide equivalent functionality are compatible with the *cl_khr_icd*
extension.

The following queries are deprecated (see glossary) in OpenCL 1.2:
Expand Down
Loading

0 comments on commit bb7df89

Please sign in to comment.