@@ -266,11 +266,20 @@ _Throws:_
266
266
267
267
* An `exception` with the `errc::build` error code if the compilation or
268
268
linking operations fail.
269
- In this case, the exception `what` string contains a description of the
270
- error.
269
+ In this case, the exception `what` string provides a full build log,
270
+ including descriptions of any errors, warning messages, and other
271
+ diagnostics.
271
272
This string is intended for human consumption, and the format may not be
272
273
stable across implementations of this extension.
273
274
275
+ [NOTE]
276
+ ====
277
+ An uncaught `errc::build` exception may result in some or all of the source
278
+ code used to create the kernel bundle being printed to the terminal.
279
+ In situations where this is undesirable, developers must ensure that the
280
+ exception is caught and handled appropriately.
281
+ ====
282
+
274
283
Overload (2):
275
284
276
285
_Constraints:_ Same as overload (1).
327
336
----
328
337
namespace sycl::ext::oneapi::experimental {
329
338
330
- struct build_log {
339
+ struct save_log {
331
340
std::string *log;
332
- build_log (std::string *log ); (1)
341
+ save_log (std::string *to ); (1)
333
342
};
334
- using build_log_key = build_log ;
343
+ using save_log_key = save_log ;
335
344
336
345
template<>
337
- struct is_property_key<build_log_key > : std::true_type {};
346
+ struct is_property_key<save_log_key > : std::true_type {};
338
347
339
348
} // namespace sycl::ext::oneapi::experimental {
340
349
----
@@ -347,15 +356,15 @@ build.
347
356
When a build fails, an `exception` is thrown and the exception's `what` string
348
357
provides a description of the error.
349
358
350
- Instead, the `build_log ` property provides information about a build operation
359
+ Instead, the `save_log ` property provides information about a build operation
351
360
that succeeds.
352
361
This might include warning messages or other diagnostics.
353
362
Each source language specification can define specific information that is
354
363
provided in the log.
355
364
In general, the log information is intended for human consumption, and the
356
365
format may not be stable across implementations of this extension.
357
366
358
- _Effects (1):_ Constructs a `build_log ` property with a pointer to a
367
+ _Effects (1):_ Constructs a `save_log ` property with a pointer to a
359
368
`std::string`.
360
369
When the `build` function completes successfully, this string will contain the
361
370
log.
0 commit comments