Skip to content

Commit 1b31169

Browse files
authored
[SYCL][Doc]Editorial fixes to kernel compiler spec (#11982)
Fix some minor spec problems I noticed while preparing a larger change. None of these should affect the implementation.
1 parent e0314fe commit 1b31169

File tree

1 file changed

+8
-17
lines changed

1 file changed

+8
-17
lines changed

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ https://github.com/intel/llvm/issues
3737

3838
== Dependencies
3939

40-
This extension is written against the SYCL 2020 revision 7 specification.
40+
This extension is written against the SYCL 2020 revision 8 specification.
4141
All references below to the "core SYCL specification" or to section numbers in
4242
the SYCL specification refer to that revision.
4343

@@ -215,13 +215,13 @@ a!
215215
----
216216
namespace sycl::ext::oneapi::experimental {
217217
218-
template<typename PropertyListT = properties<>> (1)
218+
template<typename PropertyListT = empty_properties_t> (1)
219219
kernel_bundle<bundle_state::executable> build(
220220
const kernel_bundle<bundle_state::ext_oneapi_source>& sourceBundle,
221221
const std::vector<device> &devs,
222222
PropertyListT props = {})
223223
224-
template<typename PropertyListT = properties<>> (2)
224+
template<typename PropertyListT = empty_properties_t> (2)
225225
kernel_bundle<bundle_state::executable> build(
226226
const kernel_bundle<bundle_state::ext_oneapi_source>& sourceBundle,
227227
PropertyListT props = {})
@@ -230,13 +230,11 @@ kernel_bundle<bundle_state::executable> build(
230230
----
231231
!====
232232

233-
Overload (1):
234-
235233
_Constraints:_ Available only when `PropertyListT` is an instance of
236234
`sycl::ext::oneapi::experimental::properties` which contains no properties
237235
other than those listed below in the section "New properties".
238236

239-
_Effects:_ The source code from `sourceBundle` is translated into one or more
237+
_Effects (1):_ The source code from `sourceBundle` is translated into one or more
240238
device images of state `bundle_state::executable`, and a new kernel bundle is
241239
created to contain these device images.
242240
The new bundle represents all of the kernels in `sourceBundle` that are
@@ -247,6 +245,8 @@ Any remaining kernels (those that are not compatible with any of the devices in
247245
The new bundle has the same associated context as `sourceBundle`, and the new
248246
bundle's set of associated devices is `devs` (with duplicate devices removed).
249247

248+
_Effects (2)_: Equivalent to `build(sourceBundle, ctxt.get_devices(), props)`.
249+
250250
_Returns:_ The newly created kernel bundle, which has `executable` state.
251251

252252
_Throws:_
@@ -274,12 +274,6 @@ source code used to create the kernel bundle being printed to the terminal.
274274
In situations where this is undesirable, developers must ensure that the
275275
exception is caught and handled appropriately.
276276
_{endnote}_]
277-
278-
Overload (2):
279-
280-
_Constraints:_ Same as overload (1).
281-
282-
_Effects:_ Equivalent to `build(sourceBundle, ctxt.get_devices(), props)`.
283277
|====
284278

285279
=== New properties
@@ -333,7 +327,7 @@ namespace sycl::ext::oneapi::experimental {
333327
334328
struct save_log {
335329
std::string *log;
336-
save_log(std::string *to);
330+
save_log(std::string *to); (1)
337331
};
338332
using save_log_key = save_log;
339333
@@ -359,7 +353,7 @@ provided in the log.
359353
In general, the log information is intended for human consumption, and the
360354
format may not be stable across implementations of this extension.
361355

362-
_Effects:_ Constructs a `save_log` property with a pointer to a `std::string`.
356+
_Effects (1):_ Constructs a `save_log` property with a pointer to a `std::string`.
363357
When the `build` function completes successfully, this string will contain the
364358
log.
365359

@@ -426,10 +420,7 @@ template <bundle_state State>
426420
class kernel_bundle {
427421
// ...
428422

429-
// Available only if bundle_state is not bundle_state::ext_oneapi_source
430423
bool ext_oneapi_has_kernel(const std::string &name);
431-
432-
// Available only if bundle_state is bundle_state::executable
433424
kernel ext_oneapi_get_kernel(const std::string &name);
434425
};
435426

0 commit comments

Comments
 (0)