Skip to content

Commit 267c89f

Browse files
[SYCL][Graph] Adds a detail section in the comment of bith functions
1 parent 043b4d2 commit 267c89f

File tree

4 files changed

+33
-0
lines changed

4 files changed

+33
-0
lines changed

include/ur_api.h

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8164,6 +8164,11 @@ urCommandBufferAppendMemBufferFillExp(
81648164
///////////////////////////////////////////////////////////////////////////////
81658165
/// @brief Append a USM Prefetch command to a command-buffer object
81668166
///
8167+
/// @details
8168+
/// - Prefetching may not be supported for all devices or allocation types.
8169+
/// If memory prefetching is not supported, the prefetch hint will be
8170+
/// ignored.
8171+
///
81678172
/// @returns
81688173
/// - ::UR_RESULT_SUCCESS
81698174
/// - ::UR_RESULT_ERROR_UNINITIALIZED
@@ -8200,6 +8205,11 @@ urCommandBufferAppendUSMPrefetchExp(
82008205
///////////////////////////////////////////////////////////////////////////////
82018206
/// @brief Append a USM Advise command to a command-buffer object
82028207
///
8208+
/// @details
8209+
/// - Not all memory advice hints may be supported for all devices or
8210+
/// allocation types. If a memory advice hint is not supported, it will be
8211+
/// ignored.
8212+
///
82038213
/// @returns
82048214
/// - ::UR_RESULT_SUCCESS
82058215
/// - ::UR_RESULT_ERROR_UNINITIALIZED

scripts/core/exp-command-buffer.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -591,6 +591,9 @@ type: function
591591
desc: "Append a USM Prefetch command to a command-buffer object"
592592
class: $xCommandBuffer
593593
name: AppendUSMPrefetchExp
594+
details:
595+
- "Prefetching may not be supported for all devices or allocation types. If memory prefetching
596+
is not supported, the prefetch hint will be ignored."
594597
params:
595598
- type: $x_exp_command_buffer_handle_t
596599
name: hCommandBuffer

source/loader/ur_libapi.cpp

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7614,6 +7614,11 @@ ur_result_t UR_APICALL urCommandBufferAppendMemBufferFillExp(
76147614
///////////////////////////////////////////////////////////////////////////////
76157615
/// @brief Append a USM Prefetch command to a command-buffer object
76167616
///
7617+
/// @details
7618+
/// - Prefetching may not be supported for all devices or allocation types.
7619+
/// If memory prefetching is not supported, the prefetch hint will be
7620+
/// ignored.
7621+
///
76177622
/// @returns
76187623
/// - ::UR_RESULT_SUCCESS
76197624
/// - ::UR_RESULT_ERROR_UNINITIALIZED
@@ -7665,6 +7670,11 @@ ur_result_t UR_APICALL urCommandBufferAppendUSMPrefetchExp(
76657670
///////////////////////////////////////////////////////////////////////////////
76667671
/// @brief Append a USM Advise command to a command-buffer object
76677672
///
7673+
/// @details
7674+
/// - Not all memory advice hints may be supported for all devices or
7675+
/// allocation types. If a memory advice hint is not supported, it will be
7676+
/// ignored.
7677+
///
76687678
/// @returns
76697679
/// - ::UR_RESULT_SUCCESS
76707680
/// - ::UR_RESULT_ERROR_UNINITIALIZED

source/ur_api.cpp

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6427,6 +6427,11 @@ ur_result_t UR_APICALL urCommandBufferAppendMemBufferFillExp(
64276427
///////////////////////////////////////////////////////////////////////////////
64286428
/// @brief Append a USM Prefetch command to a command-buffer object
64296429
///
6430+
/// @details
6431+
/// - Prefetching may not be supported for all devices or allocation types.
6432+
/// If memory prefetching is not supported, the prefetch hint will be
6433+
/// ignored.
6434+
///
64306435
/// @returns
64316436
/// - ::UR_RESULT_SUCCESS
64326437
/// - ::UR_RESULT_ERROR_UNINITIALIZED
@@ -6469,6 +6474,11 @@ ur_result_t UR_APICALL urCommandBufferAppendUSMPrefetchExp(
64696474
///////////////////////////////////////////////////////////////////////////////
64706475
/// @brief Append a USM Advise command to a command-buffer object
64716476
///
6477+
/// @details
6478+
/// - Not all memory advice hints may be supported for all devices or
6479+
/// allocation types. If a memory advice hint is not supported, it will be
6480+
/// ignored.
6481+
///
64726482
/// @returns
64736483
/// - ::UR_RESULT_SUCCESS
64746484
/// - ::UR_RESULT_ERROR_UNINITIALIZED

0 commit comments

Comments
 (0)