Skip to content

Commit a213303

Browse files
committed
doc: update
1 parent c39587b commit a213303

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1185,9 +1185,10 @@ where `devPtr` points to user-managed device-accessible memory and
11851185
data is allocated, but the buffer data provided by the user is used. The
11861186
buffer data must remain valid for as long as the buffer may be used, and
11871187
the user is responsible to free the buffer data when no longer required.
1188-
The user must also ensure that the memory is accessible by the device by
1189-
using allocation functions supported by the device
1190-
(e.g. `sycl::malloc_device`, `cudaMalloc`, `hipMalloc`).
1188+
The user must also ensure that the memory is accessible to the device by
1189+
using a supported allocation function (e.g., `sycl::malloc_device`,
1190+
`cudaMalloc`, `hipMalloc`) and alignment (e.g., Metal requires the
1191+
allocation to be page-aligned).
11911192
11921193
Buffers can be also imported from graphics APIs as external memory, to
11931194
avoid expensive copying of data through host memory. Different types of

doc/api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -714,8 +714,8 @@ its size in bytes. At buffer construction time no buffer data is allocated, but
714714
the buffer data provided by the user is used. The buffer data must remain valid
715715
for as long as the buffer may be used, and the user is responsible to free the
716716
buffer data when no longer required. The user must also ensure that the memory is
717-
accessible to the device by using a supported allocation function (e.g.
718-
`sycl::malloc_device`, `cudaMalloc`, `hipMalloc`) and alignment (e.g. Metal
717+
accessible to the device by using a supported allocation function (e.g.,
718+
`sycl::malloc_device`, `cudaMalloc`, `hipMalloc`) and alignment (e.g., Metal
719719
requires the allocation to be page-aligned).
720720

721721
Buffers can be also imported from graphics APIs as external memory, to avoid

readme.pdf

57 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)