Skip to content

Commit 64e92cb

Browse files
authored
[SYCL][DOC] Move SPIR-V and OpenCL extensions (#5578)
The SPIR-V and OpenCL extensions are not SYCL extensions, rather they are extensions to underlying components used by DPC++. Therefore, we consider them part of the design, so move them to "doc/design". Our policy is to remove SPIR-V and OpenCL extension specifications from this repo once they are added to the Khronos registry. The "SPV_INTEL_arbitrary_precision_int" extension was already added there, so remove it from this repo.
1 parent 1a8f501 commit 64e92cb

20 files changed

+23
-100
lines changed

sycl/ReleaseNotes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1185,7 +1185,7 @@ Release notes for commit range 5976ff0..1fc0e4f
11851185
[c4c3494]
11861186

11871187
### Documentation
1188-
- Added documentation for [`SPV_INTEL_usm_storage_classes`](doc/extensions/SPIRV/SPV_INTEL_usm_storage_classes.asciidoc)
1188+
- Added documentation for [`SPV_INTEL_usm_storage_classes`](doc/design/spirv-extensions/SPV_INTEL_usm_storage_classes.asciidoc)
11891189
and [SYCL_INTEL_usm_address_spaces](doc/extensions/supported/SYCL_EXT_INTEL_USM_ADDRESS_SPACES.asciidoc) [781fbfc]
11901190
- Fixed SPIR-V format name spelling [6e9bf3b]
11911191
- Added extension [LocalMemory](doc/extensions/supported/SYCL_EXT_ONEAPI_LOCAL_MEMORY.asciidoc) draft specification [4b5308a]

sycl/doc/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@
4949
exclude_patterns = [
5050
# Extensions are mostly in asciidoc which has poor support in Sphinx.
5151
'extensions/*',
52+
'design/opencl-extensions/*',
53+
'design/spirv-extensions/*',
5254

5355
# Sphinx complains about syntax errors in these files.
5456
'design/DeviceLibExtensions.rst',

sycl/doc/design/DeviceGlobal.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ has the `implement_in_csr` property). See the
403403
[SPV\_INTEL\_global\_variable\_decorations][6] SPIR-V extension for details
404404
about all of these decorations.
405405

406-
[6]: <../extensions/DeviceGlobal/SPV_INTEL_global_variable_decorations.asciidoc>
406+
[6]: <spirv-extensions/SPV_INTEL_global_variable_decorations.asciidoc>
407407

408408
The `sycl-post-link` tool also create a "SYCL/device globals" property set for
409409
each device code module that contains at least one device global variable.
@@ -614,7 +614,7 @@ The OpenCL backend has a proposed extension
614614
which can be easily used to implement these PI interfaces. This DPC++ design
615615
depends upon implementation of that OpenCL extension.
616616

617-
[10]: <../extensions/DeviceGlobal/cl_intel_global_variable_access.asciidoc>
617+
[10]: <opencl-extensions/cl_intel_global_variable_access.asciidoc>
618618

619619
The CUDA backend has existing APIs `cudaMemcpyToSymbol()` and
620620
`cudaMemcpyFromSymbol()` which can be used to implement these PI interfaces.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Draft OpenCL Extensions
2+
3+
This directory contains draft OpenCL extensions that are used as part of the
4+
DPC++ design. Once these extensions become fully mature, they are moved to the
5+
[Khronos OpenCL Registry][1]. Therefore, look there also for OpenCL extensions
6+
that are used by DPC++.
7+
8+
[1]: <https://www.khronos.org/registry/OpenCL>
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Draft SPIR-V Extensions
2+
3+
This directory contains draft SPIR-V extensions that are used as part of the
4+
DPC++ design. Once these extensions become fully mature, they are moved to the
5+
[Khronos SPIR-V Registry][1]. Therefore, look there also for SPIR-V extensions
6+
that are used by DPC++.
7+
8+
[1]: <https://github.com/KhronosGroup/SPIRV-Registry>

sycl/doc/extensions/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ DPC++ extensions status:
77

88
| Extension | Status | Comment |
99
|-------------|:------------|:------------|
10-
| [SPV_INTEL_function_pointers](SPIRV/SPV_INTEL_function_pointers.asciidoc) | Supported(OpenCL: CPU, GPU; HOST) | |
11-
| [SPV_INTEL_inline_assembly](SPIRV/SPV_INTEL_inline_assembly.asciidoc) | Supported(OpenCL: GPU) | |
1210

1311
Legend:
1412

sycl/doc/extensions/SPIRV/SPV_INTEL_arbitrary_precision_int.asciidoc

Lines changed: 0 additions & 95 deletions
This file was deleted.

sycl/doc/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ Design Documents for the oneAPI DPC++ Compiler
4141
design/ITTAnnotations
4242
design/DeviceGlobal
4343
design/CompileTimeProperties
44+
New OpenCL Extensions <https://github.com/intel/llvm/tree/sycl/sycl/doc/design/opencl-extensions>
45+
New SPIR-V Extensions <https://github.com/intel/llvm/tree/sycl/sycl/doc/design/spirv-extensions>
4446

4547
Developer Documentation
4648
~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)