Skip to content

Commit d54708a

Browse files
gmlueckgmlueck
authored
[SYCL][DOC] Introductory material for extensions (#5605)
Add an overview README for the extensions directory and tweak the other READMEs.
1 parent fc6c28f commit d54708a

File tree

6 files changed

+42
-28
lines changed

6 files changed

+42
-28
lines changed

‎sycl/doc/extensions/README.md

100755100644
+18-18
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
# Extensions
1+
# SYCL Extensions in DPC++
22

3-
The directory contains documents that describe DPC++ extensions to SYCL
4-
specification.
3+
The DPC++ compiler supports the [SYCL language][1]. In addition to the core
4+
SYCL features, DPC++ also implements certain extensions, and this directory
5+
contains the specifications for those extensions. These extensions are
6+
organized into subdirectories according to their state.
57

6-
DPC++ extensions status:
8+
[1]: <https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html>
79

8-
| Extension | Status | Comment |
9-
|-------------|:------------|:------------|
10+
| Directory | Description |
11+
|------------------|---------------------------------------------------------------|
12+
|[supported][2] | Extensions which are fully supported |
13+
|[experimental][3] | Extensions which are implemented but may change in the future |
14+
|[deprecated][4] | Extensions which are supported but will be removed soon |
15+
|[proposed][5] | Extensions which proposed but not yet implemented |
16+
|[removed][6] | Extensions which used to be supported but are now removed |
1017

11-
Legend:
12-
13-
| Keyword | Meaning |
14-
|-------------|:------------|
15-
| Proposal | A document describing an extension is published, but the extension is not supported yet |
16-
| Supported | An extension is supported |
17-
| Partially supported | An extension is partially supported, see comments column for more info |
18-
| Deprecated | An extension is deprecated and can be removed in future versions |
19-
| (API: DeviceType1, DeviceType2) | An extension is supported when specific combination of API and device types are used. If device type or API are not mentioned then an extension is supported on any device type or API. API can be OpenCL, CUDA, HOST. DeviceType can be CPU, GPU, ACCELERATOR |
20-
21-
22-
See [User Manual](../UsersManual.md) to find information how to enable extensions.
18+
[2]: <supported>
19+
[3]: <experimental>
20+
[4]: <deprecated>
21+
[5]: <proposed>
22+
[6]: <removed>

‎sycl/doc/extensions/deprecated/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Deprecated Extensions
2+
3+
This directory contains specifications for the SYCL extensions which are
4+
deprecated in the DPC++ compiler. These extensions are still supported, but we
5+
plan to remove them soon. Applications which use these extensions are
6+
encouraged to use an alternative instead.

‎sycl/doc/extensions/experimental/README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
# Experimental Extensions
2+
13
This directory contains the specifications for SYCL extensions that are
2-
considered experimental in the DPC++ implementation. The APIs in these
3-
extensions are not stable. They may be changed or even removed in subsequent
4-
releases of DPC++ without prior notice. As a result, they are not recommended
5-
for use in production code.
4+
considered experimental in the DPC++ compiler. The APIs in these extensions
5+
are not stable. They may be changed or even removed in subsequent releases of
6+
DPC++ without prior notice. As a result, they are not recommended for use in
7+
production code.
68

79
Experimental extensions may eventually be promoted to "supported". When this
810
happens, a new specification is added to the "supported" directory, which may

‎sycl/doc/extensions/proposed/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
# Proposed Extensions
2+
13
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.
4+
proposed for the DPC++ compiler. These extensions are not implemented in
5+
DPC++, so they cannot be used. These extension documents are published here to
6+
gather community feedback.
57

68
A proposed extension may eventually be implemented, thus promoting it to
79
"supported" or "experimental". When this happens, the specification document

‎sycl/doc/extensions/removed/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Removed Extensions
2+
13
This directory contains an archive of old DPC++ extensions which are no longer
24
implemented.
35

‎sycl/doc/extensions/supported/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
# Supported Extensions
2+
13
This directory contains the specifications for SYCL extensions that are fully
2-
supported by the DPC++ implementation. The APIs in these extensions are
3-
generally stable in future releases of DPC++, retaining backward compatibility
4-
with application code.
4+
supported by the DPC++ compiler. The APIs in these extensions are generally
5+
stable in future releases of DPC++, retaining backward compatibility with
6+
application code.
57

68
If support is dropped for one of these extensions, it goes through a
79
deprecation process. The APIs in the extension are first marked "deprecated",

0 commit comments

Comments
 (0)