Skip to content

Commit c662a34

Browse files
authored
[SYCL][Doc] Improve documentation readability. (#10994)
Reduce line length to 80 characters. Remove unnecessary white spaces and symbols from the device descriptor table.
1 parent 511fa69 commit c662a34

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

sycl/doc/extensions/experimental/sycl_ext_codeplay_max_registers_per_work_group_query.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,29 @@ This document describes an **experimental** API that applications can use to try
66
out a new feature. Future versions of this API may change in ways that are
77
incompatible with this experimental version.
88

9-
109
## Introduction
1110

12-
This extension adds a new device information descriptor that provides the ability to query a device for the maximum number of registers available per work-group.
11+
This extension adds a new device information descriptor that provides the
12+
ability to query a device for the maximum number of registers available per
13+
work-group.
1314

14-
OpenCL never offered such query due to the nature of being a very platform specific one - which is why it is also absent from SYCL. Now that SYCL supports back-ends where the register usage is a limiting resource factor of the possible maximum work-group size for a kernel, having the ability to query that limit is important for writing safe and portable code.
15+
OpenCL never offered such query due to the nature of being a very platform
16+
specific one - which is why it is also absent from SYCL. Now that SYCL supports
17+
back-ends where the register usage is a limiting resource factor of the possible
18+
maximum work-group size for a kernel, having the ability to query that limit is
19+
important for writing safe and portable code.
1520

1621
## Feature test macro
1722

18-
As encouraged by the SYCL specification, a feature-test macro, `SYCL_EXT_CODEPLAY_MAX_REGISTERS_PER_WORK_GROUP_QUERY`, is provided to determine whether this extension is implemented.
23+
As encouraged by the SYCL specification, a feature-test macro,
24+
`SYCL_EXT_CODEPLAY_MAX_REGISTERS_PER_WORK_GROUP_QUERY`, is provided to determine
25+
whether this extension is implemented.
1926

2027
## New device descriptor
2128

22-
| Device descriptor | Return type | Description |
23-
| ------------------------------------------------------ | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
24-
| ext::codeplay::experimental::info::device::max_registers_per_work_group |  unsigned int | Returns the maximum number of registers available for use per work-group based on the capability of the device. |
29+
| Device descriptor | Return type | Description |
30+
| ----------------- | ----------- | ----------- |
31+
| ext::codeplay::experimental::info::device::max_registers_per_work_group | unsigned int | Returns the maximum number of registers available for use per work-group based on the capability of the device. |
2532

2633
### Note
2734

0 commit comments

Comments
 (0)