Skip to content

[SYCL][DOC] Move SPIR-V and OpenCL extensions #5578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sycl/ReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -1185,7 +1185,7 @@ Release notes for commit range 5976ff0..1fc0e4f
[c4c3494]

### Documentation
- Added documentation for [`SPV_INTEL_usm_storage_classes`](doc/extensions/SPIRV/SPV_INTEL_usm_storage_classes.asciidoc)
- Added documentation for [`SPV_INTEL_usm_storage_classes`](doc/design/spirv-extensions/SPV_INTEL_usm_storage_classes.asciidoc)
and [SYCL_INTEL_usm_address_spaces](doc/extensions/supported/SYCL_EXT_INTEL_USM_ADDRESS_SPACES.asciidoc) [781fbfc]
- Fixed SPIR-V format name spelling [6e9bf3b]
- Added extension [LocalMemory](doc/extensions/supported/SYCL_EXT_ONEAPI_LOCAL_MEMORY.asciidoc) draft specification [4b5308a]
Expand Down
2 changes: 2 additions & 0 deletions sycl/doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@
exclude_patterns = [
# Extensions are mostly in asciidoc which has poor support in Sphinx.
'extensions/*',
'design/opencl-extensions/*',
'design/spirv-extensions/*',

# Sphinx complains about syntax errors in these files.
'design/DeviceLibExtensions.rst',
Expand Down
4 changes: 2 additions & 2 deletions sycl/doc/design/DeviceGlobal.md
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ has the `implement_in_csr` property). See the
[SPV\_INTEL\_global\_variable\_decorations][6] SPIR-V extension for details
about all of these decorations.

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

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

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

The CUDA backend has existing APIs `cudaMemcpyToSymbol()` and
`cudaMemcpyFromSymbol()` which can be used to implement these PI interfaces.
Expand Down
8 changes: 8 additions & 0 deletions sycl/doc/design/opencl-extensions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Draft OpenCL Extensions

This directory contains draft OpenCL extensions that are used as part of the
DPC++ design. Once these extensions become fully mature, they are moved to the
[Khronos OpenCL Registry][1]. Therefore, look there also for OpenCL extensions
that are used by DPC++.

[1]: <https://www.khronos.org/registry/OpenCL>
8 changes: 8 additions & 0 deletions sycl/doc/design/spirv-extensions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Draft SPIR-V Extensions

This directory contains draft SPIR-V extensions that are used as part of the
DPC++ design. Once these extensions become fully mature, they are moved to the
[Khronos SPIR-V Registry][1]. Therefore, look there also for SPIR-V extensions
that are used by DPC++.

[1]: <https://github.com/KhronosGroup/SPIRV-Registry>
File renamed without changes.
File renamed without changes.
2 changes: 0 additions & 2 deletions sycl/doc/extensions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ DPC++ extensions status:

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

Legend:

Expand Down

This file was deleted.

2 changes: 2 additions & 0 deletions sycl/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ Design Documents for the oneAPI DPC++ Compiler
design/ITTAnnotations
design/DeviceGlobal
design/CompileTimeProperties
New OpenCL Extensions <https://github.com/intel/llvm/tree/sycl/sycl/doc/design/opencl-extensions>
New SPIR-V Extensions <https://github.com/intel/llvm/tree/sycl/sycl/doc/design/spirv-extensions>

Developer Documentation
~~~~~~~~~~~~~~~~~~~~~~~
Expand Down