Skip to content

Commit eb350ee

Browse files
authored
[SYCL][DOC] Move proposed extension docs (#5437)
Move the proposed extensions to the "sycl/doc/extensions/proposed" directory, and add a README explaining the content of that directory. Each extension document has also been renamed to match the name of its feature-test macro. Links to these extensions have been removed from the table in "sycl/doc/extensions/README.md" because we want to avoid the possibility of that table getting out-of-date with the directory contents. Instead, users can see the list of proposed extensions by listing the content of the directory.
1 parent ec9d089 commit eb350ee

13 files changed

+18
-14
lines changed

sycl/ReleaseNotes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -271,11 +271,11 @@ Release notes for commit range 6a49170027fb..962909fe9e78
271271
extension specification [edaee9b]
272272
- Added [initial draft](doc/extensions/supported/SYCL_EXT_ONEAPI_BACKEND_LEVEL_ZERO.md)
273273
for querying of free device memory in LevelZero backend extension [fa428bf]
274-
- Added [InvokeSIMD](doc/extensions/InvokeSIMD/InvokeSIMD.asciidoc) and
275-
[Uniform](doc/extensions/Uniform/Uniform.asciidoc) extensions [72e1611]
274+
- Added [InvokeSIMD](doc/extensions/proposed/SYCL_EXT_ONEAPI_INVOKE_SIMD.asciidoc) and
275+
[Uniform](doc/extensions/proposed/SYCL_EXT_ONEAPI_UNIFORM.asciidoc) extensions [72e1611]
276276
- Added [Matrix Programming Extension for DPC++ document](doc/extensions/experimental/SYCL_EXT_ONEAPI_MATRIX.asciidoc) [ace4c733]
277277
- Implemented SYCL 2020 `sycl::span` [9356d53]
278-
- Added [device-if](doc/extensions/DeviceIf/device_if.asciidoc) extension
278+
- Added [device-if](doc/extensions/proposed/SYCL_EXT_ONEAPI_DEVICE_IF.asciidoc) extension
279279
[4fb95fc]
280280
- Added a [programming guide](doc/MultiTileCardWithLevelZero.md) for
281281
multi-tile and multi-card under Level Zero backend [d581178a]

sycl/doc/CompileTimeProperties.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ One use for compile-time properties is with types that are used exclusively
4040
for declaring global variables. One such example is the
4141
[SYCL\_EXT\_ONEAPI\_DEVICE\_GLOBAL][2] extension:
4242

43-
[2]: <extensions/DeviceGlobal/SYCL_INTEL_device_global.asciidoc>
43+
[2]: <extensions/proposed/SYCL_EXT_ONEAPI_DEVICE_GLOBAL.asciidoc>
4444

4545
```
4646
namespace sycl::ext::oneapi {
@@ -270,11 +270,11 @@ the property value to a string if it is not already a string.
270270
## Properties on kernel functions
271271

272272
Compile-time properties can also be used to decorate kernel functions as with
273-
the [SYCL\_EXT\_ONEAPI\_KERNEL\_PROPERTIES][8] extension. There are two ways
274-
the application can specify these properties. The first is by passing a
273+
the [SYCL\_EXT\_ONEAPI\_PROPERTIES][8] extension. There are two ways the
274+
application can specify these properties. The first is by passing a
275275
`property_list` parameter to the function that submits the kernel:
276276

277-
[8]: <https://github.com/intel/llvm/blob/sycl/sycl/doc/extensions/KernelProperties/KernelProperties.asciidoc>
277+
[8]: <extensions/proposed/SYCL_EXT_ONEAPI_PROPERTIES.asciidoc>
278278

279279
```
280280
namespace sycl {

sycl/doc/DeviceGlobal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document describes the implementation design for the DPC++ extension
44
[SYCL\_EXT\_ONEAPI\_DEVICE\_GLOBAL][1], which allows applications to declare
55
global variables in device code.
66

7-
[1]: <extensions/DeviceGlobal/SYCL_INTEL_device_global.asciidoc>
7+
[1]: <extensions/proposed/SYCL_EXT_ONEAPI_DEVICE_GLOBAL.asciidoc>
88

99

1010
## Requirements

sycl/doc/OptionalDeviceFeatures.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ non-FPGA users may want to use the `device_global` property
266266
[`device_image_scope`][5], which requires even non-FPGA users to have precise
267267
control over the way kernels are bundled into device images.
268268

269-
[5]: <extensions/DeviceGlobal/SYCL_INTEL_device_global.asciidoc#properties-for-device-global-variables>
269+
[5]: <extensions/proposed/SYCL_EXT_ONEAPI_DEVICE_GLOBAL.asciidoc#properties-for-device-global-variables>
270270

271271
The new definition of `-fsycl-device-code-split` is as follows:
272272

sycl/doc/extensions/README.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,7 @@ DPC++ extensions status:
1515
| [SYCL_INTEL_static_local_memory_query](StaticLocalMemoryQuery/SYCL_INTEL_static_local_memory_query.asciidoc) | Proposal | |
1616
| [Sub-groups for NDRange Parallelism](SubGroupNDRange/SubGroupNDRange.md) | Deprecated(OpenCL: CPU, GPU) | |
1717
| [Sub-groups](SubGroup/SYCL_INTEL_sub_group.asciidoc) | Deprecated | |
18-
| [SYCL_EXT_ONEAPI_DEVICE_IF](DeviceIf/device_if.asciidoc) | Proposal | |
19-
| [Invoke SIMD](InvokeSIMD/InvokeSIMD.asciidoc) | Proposal | |
20-
| [Uniform](Uniform/Uniform.asciidoc) | Proposal | |
21-
| [SYCL_EXT_ONEAPI_DEVICE_GLOBAL](DeviceGlobal/SYCL_INTEL_device_global.asciidoc) | Proposal | |
2218
| [Property List](PropertyList/SYCL_EXT_ONEAPI_property_list.asciidoc) | Proposal | |
23-
| [KernelProperties](KernelProperties/KernelProperties.asciidoc) | Proposal | |
2419
| [DiscardQueueEvents](DiscardQueueEvents/SYCL_EXT_ONEAPI_DISCARD_QUEUE_EVENTS.asciidoc) | Proposal | |
2520

2621
Legend:
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
This directory contains the specifications for SYCL extensions that are
2+
proposed for the DPC++ implementation. These extensions are not implemented
3+
in DPC++, so they cannot be used. These extension documents are published
4+
here to gather community feedback.
5+
6+
A proposed extension may eventually be implemented, thus promoting it to
7+
"supported" or "experimental". When this happens, the specification document
8+
is generally moved to either the "supported" or "experimental" directory, and
9+
there may also be some changes to its APIs.

0 commit comments

Comments
 (0)