Skip to content

Commit bb480d8

Browse files
authored
fix footnotes (#1097)
Moves text for CL_KERNEL_ARG_TYPE_QUALIFIER out of a footnote and into the main spec text. Removes link to the cl_khr_fp16 extension for the footnote. This is not ideal, but is a reasonable short-term solution.
1 parent 2e912fd commit bb480d8

2 files changed

Lines changed: 23 additions & 18 deletions

File tree

api/footnotes.asciidoc

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -68,19 +68,6 @@ This value for memory_scope can only be used with atomic_work_item_fence with fl
6868
Note that the performance of 64-bit integer arithmetic can vary significantly between embedded devices. \
6969
]
7070

71-
:fn-kernel-arg-type-const-addr-space: pass:n[ \
72-
{CL_KERNEL_ARG_TYPE_CONST} is returned for {CL_KERNEL_ARG_TYPE_QUALIFIER} if the argument is declared with the `constant` address space qualifier. \
73-
]
74-
75-
:fn-kernel-arg-type-qualifier: pass:n[ \
76-
{CL_KERNEL_ARG_TYPE_CONST} is returned if the argument is a pointer and the referenced type is declared with the const qualifier. \
77-
For example, a kernel argument declared as `global int const *x` returns {CL_KERNEL_ARG_TYPE_CONST} but a kernel argument declared as `global int * const x` does not. + \
78-
Similarly, {CL_KERNEL_ARG_TYPE_RESTRICT} will be returned if the pointer type is marked `restrict`. \
79-
For example, `global int * restrict x` returns {CL_KERNEL_ARG_TYPE_RESTRICT}. + \
80-
{CL_KERNEL_ARG_TYPE_VOLATILE} is returned for {CL_KERNEL_ARG_TYPE_QUALIFIER} if the argument is a pointer and the referenced type is declared with the volatile qualifier. \
81-
For example, a kernel argument declared as `global int volatile *x` returns {CL_KERNEL_ARG_TYPE_VOLATILE} but a kernel argument declared as `global int * volatile x` does not. \
82-
]
83-
8471
:fn-map-count-usage: pass:n[ \
8572
The map count returned should be considered immediately stale. \
8673
It is unsuitable for general use in applications. \
@@ -120,7 +107,7 @@ Rather than attempt to share {cl_kernel_TYPE} objects among multiple host thread
120107
]
121108

122109
:fn-readimageh: pass:n[ \
123-
And *read_imageh*, if the `<<cl_khr_fp16>>` extension is supported. \
110+
And *read_imageh*, if the `cl_khr_fp16` extension is supported. \
124111
]
125112

126113
:fn-reference-count-usage: pass:n[ \

api/opencl_runtime_layer.asciidoc

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11078,15 +11078,33 @@ include::{generated}/api/version-notes/CL_KERNEL_ARG_TYPE_QUALIFIER.asciidoc[]
1107811078
for the argument given by _arg_index_.
1107911079
The returned values can be:
1108011080

11081-
{CL_KERNEL_ARG_TYPE_CONST_anchor}
11082-
footnote:[{fn-kernel-arg-type-qualifier}]
11083-
footnote:[{fn-kernel-arg-type-const-addr-space}] +
11081+
{CL_KERNEL_ARG_TYPE_CONST_anchor} +
1108411082
{CL_KERNEL_ARG_TYPE_RESTRICT_anchor} +
1108511083
{CL_KERNEL_ARG_TYPE_VOLATILE_anchor} +
1108611084
{CL_KERNEL_ARG_TYPE_PIPE_anchor}, or +
1108711085
{CL_KERNEL_ARG_TYPE_NONE_anchor}
1108811086

11089-
{CL_KERNEL_ARG_TYPE_NONE} is returned for all parameters passed by
11087+
{CL_KERNEL_ARG_TYPE_CONST} is returned if the kernel argument is a
11088+
pointer and the referenced type is declared with the `const` qualifier.
11089+
For example, a kernel argument declared as `global int const*` returns
11090+
{CL_KERNEL_ARG_TYPE_CONST} but a kernel argument declared as `global
11091+
int* const` does not.
11092+
Additionally, {CL_KERNEL_ARG_TYPE_CONST} is returned if the kernel
11093+
argument is declared with the `constant` address space qualifier.
11094+
11095+
{CL_KERNEL_ARG_TYPE_RESTRICT} is returned if the pointer type is marked
11096+
`restrict`.
11097+
For example, `global int* restrict` returns
11098+
{CL_KERNEL_ARG_TYPE_RESTRICT}.
11099+
11100+
{CL_KERNEL_ARG_TYPE_VOLATILE} is returned for
11101+
{CL_KERNEL_ARG_TYPE_QUALIFIER} if the kernel argument is a pointer and
11102+
the referenced type is declared with the `volatile` qualifier.
11103+
For example, a kernel argument declared as `global int volatile*`
11104+
returns {CL_KERNEL_ARG_TYPE_VOLATILE} but a kernel argument declared as
11105+
`global int* volatile` does not.
11106+
11107+
{CL_KERNEL_ARG_TYPE_NONE} is returned for all kernel arguments passed by
1109011108
value.
1109111109
| {CL_KERNEL_ARG_NAME_anchor}
1109211110

0 commit comments

Comments
 (0)